Packages

  • package root
    Definition Classes
    root
  • package scala
    Definition Classes
    root
  • package scalajs
    Definition Classes
    scala
  • package js

    Types, methods and values for interoperability with JavaScript libraries.

    Types, methods and values for interoperability with JavaScript libraries.

    This package is only relevant to the Scala.js compiler, and should not be referenced by any project compiled to the JVM.

    Guide

    General documentation on Scala.js is available at http://www.scala-js.org/doc/.

    Overview

    The trait js.Any is the root of the hierarchy of JavaScript types. This package defines important subtypes of js.Any that are defined in the standard library of ECMAScript 5.1 (or ES 6, with a label in the documentation), such as js.Object, js.Array and js.RegExp.

    Implicit conversions to and from standard Scala types to their equivalent in JavaScript are provided. For example, from Scala functions to JavaScript functions and back.

    The most important subtypes of js.Any declared in this package are:

    The trait js.Dynamic is a special subtrait of js.Any. It can represent any JavaScript value in a dynamically-typed way. It is possible to call any method and read and write any field of a value of type js.Dynamic.

    There are no explicit definitions for JavaScript primitive types, as one could expect, because the corresponding Scala types stand in their stead:

    • Boolean is the type of primitive JavaScript booleans
    • Double is the type of primitive JavaScript numbers
    • String is the type of primitive JavaScript strings (or null)
    • Unit is the type of the JavaScript undefined value
    • Null is the type of the JavaScript null value

    js.UndefOr gives a scala.Option-like interface where the JavaScript value undefined takes the role of None.

    A | B is an unboxed pseudo-union type, suitable to type values that admit several unrelated types in facade types.

    Definition Classes
    scalajs
  • package typedarray

    ECMAScript 6 The typdearray package provides facade types for JavaScript ArrayBuffer, TypeArrays and DataView.

    ECMAScript 6 The typdearray package provides facade types for JavaScript ArrayBuffer, TypeArrays and DataView. Further, it provides conversions between primitive Scala arrays and TypedArrays

    Definition Classes
    js
  • AB2TA
  • AC2TA
  • AD2TA
  • AF2TA
  • AI2TA
  • AS2TA
  • ArrayBuffer
  • ArrayBufferInputStream
  • ArrayBufferView
  • DataView
  • DataViewExt
  • Float32Array
  • Float64Array
  • Int16Array
  • Int32Array
  • Int8Array
  • TA2AB
  • TA2AC
  • TA2AD
  • TA2AF
  • TA2AI
  • TA2AS
  • TypedArray
  • TypedArrayBuffer
  • TypedArrayBufferOps
  • TypedArrayStatic
  • Uint16Array
  • Uint32Array
  • Uint8Array
  • Uint8ClampedArray

final class TypedArrayBufferOps[TypedArrayType <: TypedArray[_, TypedArrayType]] extends AnyVal

Additional operations on a Buffer with interoperability with JavaScript Typed Arrays.

All Scala.js implementations of Buffer also implement this interface for some TypedArrayType, which depends on the type of elements in the buffer.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TypedArrayBufferOps
  2. AnyVal
  3. 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

Value Members

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from TypedArrayBufferOps[TypedArrayType] toany2stringadd[TypedArrayBufferOps[TypedArrayType]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TypedArrayBufferOps[TypedArrayType], B)
    Implicit
    This member is added by an implicit conversion from TypedArrayBufferOps[TypedArrayType] toArrowAssoc[TypedArrayBufferOps[TypedArrayType]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    Any
  6. def arrayBuffer(): ArrayBuffer

    ArrayBuffer backing this buffer _(optional operation)_.

    ArrayBuffer backing this buffer _(optional operation)_.

    Exceptions thrown

    UnsupportedOperationException If this buffer has no backing ArrayBuffer, i.e., !hasArrayBuffer()

  7. def arrayBufferOffset(): Int

    Byte offset in the associated ArrayBuffer _(optional operation)_.

    Byte offset in the associated ArrayBuffer _(optional operation)_.

    Exceptions thrown

    UnsupportedOperationException If this buffer has no backing ArrayBuffer, i.e., !hasArrayBuffer()

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def dataView(): DataView

    DataView of the backing ArrayBuffer _(optional operation)_.

    DataView of the backing ArrayBuffer _(optional operation)_.

    The DataView is sliced to the portion of the ArrayBuffer seen by this Buffer.

    Exceptions thrown

    UnsupportedOperationException If this buffer has no backing ArrayBuffer, i.e., !hasArrayBuffer()

  10. def ensuring(cond: (TypedArrayBufferOps[TypedArrayType]) => Boolean, msg: => scala.Any): TypedArrayBufferOps[TypedArrayType]
    Implicit
    This member is added by an implicit conversion from TypedArrayBufferOps[TypedArrayType] toEnsuring[TypedArrayBufferOps[TypedArrayType]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (TypedArrayBufferOps[TypedArrayType]) => Boolean): TypedArrayBufferOps[TypedArrayType]
    Implicit
    This member is added by an implicit conversion from TypedArrayBufferOps[TypedArrayType] toEnsuring[TypedArrayBufferOps[TypedArrayType]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => scala.Any): TypedArrayBufferOps[TypedArrayType]
    Implicit
    This member is added by an implicit conversion from TypedArrayBufferOps[TypedArrayType] toEnsuring[TypedArrayBufferOps[TypedArrayType]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): TypedArrayBufferOps[TypedArrayType]
    Implicit
    This member is added by an implicit conversion from TypedArrayBufferOps[TypedArrayType] toEnsuring[TypedArrayBufferOps[TypedArrayType]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TypedArrayBufferOps[TypedArrayType] toStringFormat[TypedArrayBufferOps[TypedArrayType]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  16. def hasArrayBuffer(): Boolean

    Tests whether this buffer has a valid associated ArrayBuffer.

    Tests whether this buffer has a valid associated ArrayBuffer.

    This is true iff the buffer is direct and not read-only.

  17. def hasTypedArray(): Boolean

    Tests whether this direct buffer has a valid associated TypedArray.

    Tests whether this direct buffer has a valid associated TypedArray.

    If this buffer is read-only, returns false.

    For read-write buffers:

    * Direct Byte buffers always have an associated TypedArray. * Long buffers never do. * Other kinds of direct buffers have an associated TypedArray if and only if their byte order is the native order of the platform.

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def toString(): String
    Definition Classes
    Any
  20. def typedArray(): TypedArrayType

    TypedArray backing this direct buffer _(optional operation)_.

    TypedArray backing this direct buffer _(optional operation)_.

    The TypedArray is sliced to the portion of the ArrayBuffer seen by this Buffer.

    Exceptions thrown

    UnsupportedOperationException If this buffer does not have a backing TypedArray, i.e., !hasTypedArray().

Deprecated Value Members

  1. def [B](y: B): (TypedArrayBufferOps[TypedArrayType], B)
    Implicit
    This member is added by an implicit conversion from TypedArrayBufferOps[TypedArrayType] toArrowAssoc[TypedArrayBufferOps[TypedArrayType]] 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.

Inherited from AnyVal

Inherited from scala.Any

Inherited by implicit conversion any2stringadd fromTypedArrayBufferOps[TypedArrayType] to any2stringadd[TypedArrayBufferOps[TypedArrayType]]

Inherited by implicit conversion StringFormat fromTypedArrayBufferOps[TypedArrayType] to StringFormat[TypedArrayBufferOps[TypedArrayType]]

Inherited by implicit conversion Ensuring fromTypedArrayBufferOps[TypedArrayType] to Ensuring[TypedArrayBufferOps[TypedArrayType]]

Inherited by implicit conversion ArrowAssoc fromTypedArrayBufferOps[TypedArrayType] to ArrowAssoc[TypedArrayBufferOps[TypedArrayType]]

Ungrouped