Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MapType<K, V, READ_K, READ_V>

A type storing a variable-size mapping of keys of one type to values of another

Example:

//For storing stock prices on different days
let type = new sb.MapType(
  new sb.StringType,
  new sb.MapType(
    new sb.DayType,
    new sb.FloatType
  )
)

Type parameters

  • K

    The type of values stored in keys of the map

  • V

    The type of values stored in values of the map

  • READ_K: K = K

    The type of keys this type will read

  • READ_V: V = V

    The type of values this type will read

Hierarchy

  • AbsoluteType<Map<K, V>, Map<READ_K, READ_V>>
    • MapType

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new MapType<K, V, READ_K, READ_V>(keyType: Type<K, READ_K>, valueType: Type<V, READ_V>): MapType<K, V, READ_K, READ_V>

  • Type parameters

    • K

    • V

    • READ_K = K

    • READ_V = V

    Parameters

    • keyType: Type<K, READ_K>

      The type of each key in the map

    • valueType: Type<V, READ_V>

      The type of each value in the map

    Returns MapType<K, V, READ_K, READ_V>

Properties

Readonly keyType

keyType: Type<K, READ_K>

Readonly valueType

valueType: Type<V, READ_V>

Accessors

Static _value

  • get _value(): number

Methods

addToBuffer

consumeValue

  • consumeValue(buffer: ArrayBuffer, offset: number, baseValue?: Map<READ_K, READ_V>): ReadResult<Map<READ_K, READ_V>>

  • Parameters

    • buffer: ArrayBuffer
    • offset: number
    • Optional baseValue: Map<READ_K, READ_V>

    Returns ReadResult<Map<READ_K, READ_V>>

equals

  • equals(otherType: unknown): boolean

  • Parameters

    • otherType: unknown

    Returns boolean

getHash

  • getHash(): string

getSignature

  • getSignature(): string

Private isBuffer

Private isSameType

  • isSameType(otherType: unknown): otherType is MapType<K, V, READ_K, READ_V>

  • Determines whether the input is a Type with the same class

    Parameters

    • otherType: unknown

      A value, usually a Type instance

    Returns otherType is MapType<K, V, READ_K, READ_V>

    whether this and otherType are instances of the same Type class

readValue

  • readValue(valueBuffer: ArrayBuffer | Uint8Array, offset?: number): Map<READ_K, READ_V>

  • Parameters

    • valueBuffer: ArrayBuffer | Uint8Array
    • offset: number = 0

    Returns Map<READ_K, READ_V>

toBuffer

  • toBuffer(): ArrayBuffer

valueBuffer

  • valueBuffer(value: Map<K, V>): ArrayBuffer

  • Parameters

    • value: Map<K, V>

    Returns ArrayBuffer

writeValue

  • Appends value bytes to an AppendableBuffer according to the type

    Example:

    let GOOG = new Map()
  .set(new Date(2000, 0, 1), 33.2)
  .set(new Date(2000, 0, 2), 38.5)
  .set(new Date(2000, 0, 3), 39.9)
let YHOO = new Map()
  .set(new Date(2010, 0, 1), 10.1)
  .set(new Date(2010, 0, 2), 10.2)
let AMZN = new Map()
let stocks = new Map()
  .set('GOOG', GOOG)
  .set('YHOO', YHOO)
  .set('AMZN', AMZN)
type.writeValue(buffer, stocks)
    throws

    If the value doesn't match the type, e.g. new sb.StringType().writeValue(buffer, 23)

    Parameters

    • buffer: AppendableBuffer

      The buffer to which to append

    • value: Map<K, V>

      The value to write

    Returns void

Generated using TypeDoc