scala.scalajs.js.annotation

JSImport

class JSImport extends Annotation with StaticAnnotation

Marks the annotated class or object as imported from another JS module.

Intuitively, this corresponds to ECMAScript import directives. See the documentation of the various constructors.

@JSImport is not compatible with the jsDependencies mechanism offered by the Scala.js sbt plugin. You are responsible for resolving and/or bundling the JavaScript modules that you are importing using other mechanisms.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JSImport
  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 JSImport(module: String, name: Namespace.type, globalFallback: String)

    Namespace import (import the module itself), with a fallback on a global variable.

    Namespace import (import the module itself), with a fallback on a global variable.

    When linking with module support, this is equivalent to @JSImport(module, name).

    When linking without module support, this is equivalent to @JSGlobal(globalFallback).

  2. new JSImport(module: String, name: String, globalFallback: String)

    Named import of a member of the module, with a fallback on a global variable.

    Named import of a member of the module, with a fallback on a global variable.

    When linking with module support, this is equivalent to @JSImport(module, name).

    When linking without module support, this is equivalent to @JSGlobal(globalFallback).

  3. new JSImport(module: String, name: Namespace.type)

    Namespace import (import the module itself).

    Namespace import (import the module itself).

    The second parameter should be the singleton JSImport.Namespace.

    Intuitively, this corresponds to

    import * as AnnotatedObject from <module>
  4. new JSImport(module: String, name: String)

    Named import of a member of the module.

    Named import of a member of the module.

    Intuitively, this corresponds to the following ECMAScript import directive:

    import { <name> as AnnotatedClassOrObject } from <module>

    To import the default export of a module, use JSImport.Default as name.

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 JSImport to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (JSImport, B)

    Implicit information
    This member is added by an implicit conversion from JSImport to ArrowAssoc[JSImport] 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: (JSImport) ⇒ Boolean, msg: ⇒ scala.Any): JSImport

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

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

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

    Implicit information
    This member is added by an implicit conversion from JSImport to Ensuring[JSImport] 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 JSImport 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): (JSImport, B)

    Implicit information
    This member is added by an implicit conversion from JSImport to ArrowAssoc[JSImport] 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 JSImport 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:
    (jSImport: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: scala.Any

    Implicit information
    This member is added by an implicit conversion from JSImport 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:
    (jSImport: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: JSImport

    Implicit information
    This member is added by an implicit conversion from JSImport to ArrowAssoc[JSImport] 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:
    (jSImport: ArrowAssoc[JSImport]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: JSImport

    Implicit information
    This member is added by an implicit conversion from JSImport to Ensuring[JSImport] 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:
    (jSImport: Ensuring[JSImport]).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 JSImport to StringAdd

Inherited by implicit conversion any2stringfmt from JSImport to StringFormat

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

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

Ungrouped