scala.scalajs.js.annotation

JSExportNamed

class JSExportNamed extends Annotation with StaticAnnotation

Exports the given method to JavaScript with named parameters.

It can then be called like this:

obj.foo({
  param1: value1
  param2: value2
  param7: value3
});

Note that named exports don't support overloading. Therefore the following will fail:

class A {
@JSExportNamed
def a(foo: Int) = foo + 1
@JSExportNamed
def a(bar: String) = "Hello " + bar
}

As of Scala.js 0.6.11, @JSExportNamed is deprecated without direct replacement (see https://github.com/scala-js/scala-js/issues/2442). You should take a single parameter of a JS type and decompose it yourself. For example, instead of

class A {
@JSExportNamed
def foo(a: Int, b: String, c: Boolean = false): Unit = {
  // do something with a, b, c
}
}

you should write:

trait FooOptions extends js.Object {
  val a: Int
  val b: String
  val c: js.UndefOr[Boolean]
}

class A {
  @JSExport
  def foo(options: FooOptions): Unit = {
    val a = options.a
    val b = options.b
    val c = options.c.getOrElse(false)
    // do something with a, b, c
  }
}
Annotations
@deprecated
Deprecated

(Since version 0.6.11)

See also

Export Scala.js APIs to JavaScript

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JSExportNamed
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JSExportNamed(name: String)

  2. new JSExportNamed()

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: scala.Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (JSExportNamed, B)

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to ArrowAssoc[JSExportNamed] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: scala.Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (JSExportNamed) ⇒ Boolean, msg: ⇒ scala.Any): JSExportNamed

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to Ensuring[JSExportNamed] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (JSExportNamed) ⇒ Boolean): JSExportNamed

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to Ensuring[JSExportNamed] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ scala.Any): JSExportNamed

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to Ensuring[JSExportNamed] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): JSExportNamed

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to Ensuring[JSExportNamed] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: scala.Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (JSExportNamed, B)

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to ArrowAssoc[JSExportNamed] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: scala.Any

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (jSExportNamed: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: scala.Any

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (jSExportNamed: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: JSExportNamed

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to ArrowAssoc[JSExportNamed] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (jSExportNamed: ArrowAssoc[JSExportNamed]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: JSExportNamed

    Implicit information
    This member is added by an implicit conversion from JSExportNamed to Ensuring[JSExportNamed] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (jSExportNamed: Ensuring[JSExportNamed]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from scala.Any

Inherited by implicit conversion any2stringadd from JSExportNamed to StringAdd

Inherited by implicit conversion any2stringfmt from JSExportNamed to StringFormat

Inherited by implicit conversion any2ArrowAssoc from JSExportNamed to ArrowAssoc[JSExportNamed]

Inherited by implicit conversion any2Ensuring from JSExportNamed to Ensuring[JSExportNamed]

Ungrouped