scala.scalajs.js

Dictionary

sealed trait Dictionary[A] extends Object

Dictionary "view" of a JavaScript value.

Using objects as dictionaries (maps from strings to values) through their properties is a common idiom in JavaScript. This trait lets you treat an object as such a dictionary.

To use it, cast your object, say x, into a Dictionary using

val xDict = x.asInstanceOf[js.Dictionary[Int]]

then use it as

xDict("prop") = 5
println(xDict("prop")) // displays 5
xDict.delete("prop")   // removes the property "prop"
println(xDict("prop")) // displays undefined

To enumerate all the keys of a dictionary, use js.Object.keys, which returns a js.Array of the properties. It can be used in a for comprehension like this:

for (prop <- js.Object.keys(xDict)) {
val value = xDict(prop)
println(prop + " -> " + value)
}
Annotations
@RawJSType()
Linear Supertypes
Object, Any, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Dictionary
  2. Object
  3. Any
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply(key: String): A

    Reads a field of this object by its name.

    Reads a field of this object by its name.

    Annotations
    @JSBracketAccess()

  2. abstract def update(key: String, value: A): Unit

    Writes a field of this object by its name.

    Writes a field of this object by its name.

    Annotations
    @JSBracketAccess()

Concrete Value Members

  1. final def !=(arg0: scala.Any): scala.Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. def +(other: Predef.String): Predef.String

    Implicit information
    This member is added by an implicit conversion from Dictionary[A] to any2stringadd[Dictionary[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Dictionary[A], B)

    Implicit information
    This member is added by an implicit conversion from Dictionary[A] to ArrowAssoc[Dictionary[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: scala.Any): scala.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
    @throws( ... )

  8. def delete(key: String): Unit

    Deletes a property of this object by its name.

    Deletes a property of this object by its name. The property must be configurable. This method is equivalent to the "delete" keyword in JavaScript.

    Since we are using strict mode, this throws an exception, if the property isn't configurable.

  9. def ensuring(cond: (Dictionary[A]) ⇒ scala.Boolean, msg: ⇒ scala.Any): Dictionary[A]

    Implicit information
    This member is added by an implicit conversion from Dictionary[A] to Ensuring[Dictionary[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (Dictionary[A]) ⇒ scala.Boolean): Dictionary[A]

    Implicit information
    This member is added by an implicit conversion from Dictionary[A] to Ensuring[Dictionary[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: scala.Boolean, msg: ⇒ scala.Any): Dictionary[A]

    Implicit information
    This member is added by an implicit conversion from Dictionary[A] to Ensuring[Dictionary[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: scala.Boolean): Dictionary[A]

    Implicit information
    This member is added by an implicit conversion from Dictionary[A] to Ensuring[Dictionary[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): scala.Boolean

    Definition Classes
    AnyRef

  14. def equals(arg0: scala.Any): scala.Boolean

    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: Predef.String): Predef.String

    Implicit information
    This member is added by an implicit conversion from Dictionary[A] to StringFormat[Dictionary[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  18. def hasOwnProperty(v: String): Boolean

    Tests whether this object has the specified property as a direct property.

    Tests whether this object has the specified property as a direct property.

    Unlike js.Object.hasProperty, this method does not check down the object's prototype chain.

    MDN

    Definition Classes
    Object

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: scala.Boolean

    Definition Classes
    Any

  21. def isPrototypeOf(v: Object): Boolean

    Tests whether this object is in the prototype chain of another object.

    Tests whether this object is in the prototype chain of another object.

    Definition Classes
    Object

  22. final def ne(arg0: AnyRef): scala.Boolean

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. def propertyIsEnumerable(v: String): Boolean

    Tests whether the specified property in an object can be enumerated by a call to js.Object.properties, with the exception of properties inherited through the prototype chain.

    Tests whether the specified property in an object can be enumerated by a call to js.Object.properties, with the exception of properties inherited through the prototype chain. If the object does not have the specified property, this method returns false.

    MDN

    Definition Classes
    Object

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  27. def toLocaleString(): String

    Definition Classes
    Object

  28. def toString(): java.lang.String

    Definition Classes
    AnyRef → Any

  29. def valueOf(): scala.Any

    Definition Classes
    Object

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. def →[B](y: B): (Dictionary[A], B)

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

Deprecated Value Members

  1. def unary_!(): Boolean

    Definition Classes
    Any
    Annotations
    @deprecated
    Deprecated

    (Since version 0.5.0)

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from scala.Any

Inherited by implicit conversion any2stringadd from Dictionary[A] to any2stringadd[Dictionary[A]]

Inherited by implicit conversion StringFormat from Dictionary[A] to StringFormat[Dictionary[A]]

Inherited by implicit conversion Ensuring from Dictionary[A] to Ensuring[Dictionary[A]]

Inherited by implicit conversion ArrowAssoc from Dictionary[A] to ArrowAssoc[Dictionary[A]]

Ungrouped