Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SetType<E, READ_E>

A type storing a variable-size set of values of the same type. Works much like ArrayType except all values are Sets.

Example:

//For storing some number of people
let personType = new sb.StructType({
  dob: new sb.DayType,
  name: new sb.StringType
})
let type = new sb.SetType(personType)

Type parameters

  • E

    The type of each element in the set

  • READ_E: E = E

    The type of each element in the read set

Hierarchy

  • AbsoluteType<Set<E>, Set<READ_E>>
    • SetType

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new SetType<E, READ_E>(type: Type<E, READ_E>): SetType<E, READ_E>

  • Type parameters

    • E

    • READ_E = E

    Parameters

    • type: Type<E, READ_E>

      A Type that can serialize each element in the set

    Returns SetType<E, READ_E>

Properties

Readonly type

type: Type<E, READ_E>

Accessors

Static _value

  • get _value(): number

Methods

addToBuffer

consumeValue

  • consumeValue(buffer: ArrayBuffer, offset: number, baseValue?: Set<READ_E>): ReadResult<Set<READ_E>>

  • Parameters

    • buffer: ArrayBuffer
    • offset: number
    • Optional baseValue: Set<READ_E>

    Returns ReadResult<Set<READ_E>>

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 SetType<E, READ_E>

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

    Parameters

    • otherType: unknown

      A value, usually a Type instance

    Returns otherType is SetType<E, READ_E>

    whether this and otherType are instances of the same Type class

readValue

  • readValue(valueBuffer: ArrayBuffer | Uint8Array, offset?: number): Set<READ_E>

  • Parameters

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

    Returns Set<READ_E>

toBuffer

  • toBuffer(): ArrayBuffer

valueBuffer

  • valueBuffer(value: Set<E>): ArrayBuffer

  • Parameters

    • value: Set<E>

    Returns ArrayBuffer

writeValue

  • Appends value bytes to an AppendableBuffer according to the type

    Example:

    let person1 = {dob: new Date(1980, 3, 10), name: 'Alfred'}
let person2 = {dob: new Date(1970, 4, 9), name: 'Betty'}
let person3 = {dob: new Date(1990, 5, 8), name: 'Cramer'}
type.writeValue(buffer, new Set([person1, person2, person3]))
    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: Set<E>

      The value to write

    Returns void

Generated using TypeDoc