Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArraySet<V>

A set that is backed by an array. Use arraySet to create it.

Type parameters

  • V

Hierarchy

Implements

  • Set<V>

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly $

$: { $modelId: string; items: any[] }

Data part of the model, which is observable and will be serialized in snapshots. Use it if one of the data properties matches one of the model properties/functions.

Type declaration

  • $modelId: string
  • items: any[]

Readonly $modelType

$modelType: string

Model type name.

[fromSnapshotOverrideTypeSymbol]

[fromSnapshotOverrideTypeSymbol]: never

[modelIdPropertyNameSymbol]

[modelIdPropertyNameSymbol]: "$modelId"

[propsTypeSymbol]

[propsTypeSymbol]: { $modelId: ModelIdProp; items: OptionalModelProp<any[]> }

Type declaration

[toSnapshotOverrideTypeSymbol]

[toSnapshotOverrideTypeSymbol]: never

items

items: any[] = ...

Accessors

$modelId

  • get $modelId(): [ModelIdPropertyName] extends [never] ? never : string
  • set $modelId(newId: [ModelIdPropertyName] extends [never] ? never : string): void

  • Model internal id. Can be modified inside a model action. It will return undefined if there's no id prop set.

    Returns [ModelIdPropertyName] extends [never] ? never : string

  • Model internal id. Can be modified inside a model action. It will return undefined if there's no id prop set.

    Parameters

    • newId: [ModelIdPropertyName] extends [never] ? never : string

    Returns void

[toStringTag]

  • get [toStringTag](): string

  • Returns string

size

  • get size(): number

  • Returns number

Methods

[iterator]

  • [iterator](): IterableIterator<V>

  • Returns IterableIterator<V>

add

  • Parameters

    • value: V

    Returns ArraySet<V>

clear

  • clear(): void

  • Returns void

delete

  • delete(value: V): boolean

  • Parameters

    • value: V

    Returns boolean

entries

  • entries(): IterableIterator<[V, V]>

  • Returns IterableIterator<[V, V]>

forEach

  • forEach(callbackfn: (value: V, value2: V, set: Set<V>) => void, thisArg?: any): void

  • Parameters

    • callbackfn: (value: V, value2: V, set: Set<V>) => void
        • (value: V, value2: V, set: Set<V>): void

        • Parameters

          • value: V
          • value2: V
          • set: Set<V>

          Returns void

    • Optional thisArg: any

    Returns void

getRefId

  • getRefId(): undefined | string

  • Can be overridden to offer a reference id to be used in reference resolution. By default it will use the idProp if available or return undefined otherwise.

    Returns undefined | string

has

  • has(value: V): boolean

  • Parameters

    • value: V

    Returns boolean

keys

  • keys(): IterableIterator<V>

  • Returns IterableIterator<V>

toString

  • toString(options?: { withData?: boolean }): string
  • toString(): string

  • Parameters

    • Optional options: { withData?: boolean }
      • Optional withData?: boolean

    Returns string

  • Returns a string representation of an object.

    Returns string

typeCheck

  • Performs a type check over the model instance. For this to work a data type has to be declared as part of the model properties.

    Returns null | TypeCheckError

    A TypeCheckError or null if there is no error.

values

  • values(): IterableIterator<V>

  • Returns IterableIterator<V>

Generated using TypeDoc