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
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- JSExportNamed
- StaticAnnotation
- Annotation
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Value Members
- final def !=(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from JSExportNamed toany2stringadd[JSExportNamed] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (JSExportNamed, B)
- Implicit
- This member is added by an implicit conversion from JSExportNamed toArrowAssoc[JSExportNamed] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (JSExportNamed) => Boolean, msg: => scala.Any): JSExportNamed
- Implicit
- This member is added by an implicit conversion from JSExportNamed toEnsuring[JSExportNamed] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (JSExportNamed) => Boolean): JSExportNamed
- Implicit
- This member is added by an implicit conversion from JSExportNamed toEnsuring[JSExportNamed] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => scala.Any): JSExportNamed
- Implicit
- This member is added by an implicit conversion from JSExportNamed toEnsuring[JSExportNamed] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): JSExportNamed
- Implicit
- This member is added by an implicit conversion from JSExportNamed toEnsuring[JSExportNamed] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from JSExportNamed toStringFormat[JSExportNamed] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def →[B](y: B): (JSExportNamed, B)
- Implicit
- This member is added by an implicit conversion from JSExportNamed toArrowAssoc[JSExportNamed] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.