Packages

c

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
StaticAnnotation, Annotation, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JSExportNamed
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JSExportNamed(name: String)
  2. new JSExportNamed()

Value Members

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from JSExportNamed to any2stringadd[JSExportNamed] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JSExportNamed, B)
    Implicit
    This member is added by an implicit conversion from JSExportNamed to ArrowAssoc[JSExportNamed] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def ensuring(cond: (JSExportNamed) ⇒ Boolean, msg: ⇒ scala.Any): JSExportNamed
    Implicit
    This member is added by an implicit conversion from JSExportNamed to Ensuring[JSExportNamed] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (JSExportNamed) ⇒ Boolean): JSExportNamed
    Implicit
    This member is added by an implicit conversion from JSExportNamed to Ensuring[JSExportNamed] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ scala.Any): JSExportNamed
    Implicit
    This member is added by an implicit conversion from JSExportNamed to Ensuring[JSExportNamed] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): JSExportNamed
    Implicit
    This member is added by an implicit conversion from JSExportNamed to Ensuring[JSExportNamed] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JSExportNamed to StringFormat[JSExportNamed] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  27. def →[B](y: B): (JSExportNamed, B)
    Implicit
    This member is added by an implicit conversion from JSExportNamed to ArrowAssoc[JSExportNamed] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from scala.Any

Inherited by implicit conversion any2stringadd from JSExportNamed to any2stringadd[JSExportNamed]

Inherited by implicit conversion StringFormat from JSExportNamed to StringFormat[JSExportNamed]

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

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

Ungrouped