Class ArraySet<V>

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

Type Parameters

  • V

Hierarchy

  • BaseModel<
        {
            $modelId: ModelIdProp<string> & {
                typedAs<T extends string>(): ModelIdProp<T>;
            };
            items: OptionalModelProp<any[]>;
        },
        never,
        never,
        "$modelId",
        this,
    > & Omit<{ $modelId: string; items: any[] }, BaseModelKeys> & {}
    • ArraySet

Implements

  • Set<V>

Constructors

constructor

Properties

[fromSnapshotOverrideTypeSymbol] [modelIdPropertyNameSymbol] [propsTypeSymbol] [toSnapshotOverrideTypeSymbol] [toStringTag] $ $modelType items

Accessors

$modelId size

Methods

[iterator] add clear delete difference entries forEach getRefId has intersection isDisjointFrom isSubsetOf isSupersetOf keys symmetricDifference toString typeCheck union values

Constructors

constructor

Properties

[fromSnapshotOverrideTypeSymbol]

"[fromSnapshotOverrideTypeSymbol]": never

[modelIdPropertyNameSymbol]

"[modelIdPropertyNameSymbol]": "$modelId"

[propsTypeSymbol]

"[propsTypeSymbol]": {
    $modelId: ModelIdProp<string> & {
        typedAs<T extends string>(): ModelIdProp<T>;
    };
    items: OptionalModelProp<any[]>;
}

[toSnapshotOverrideTypeSymbol]

"[toSnapshotOverrideTypeSymbol]": never

Readonly[toStringTag]

"[toStringTag]": "ArraySet"

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.

Readonly$modelType

$modelType: string

Model type name.

items

items: any[] = ...

Accessors

$modelId

  • get $modelId(): ModelIdPropertyType<TProps, ModelIdPropertyName>

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

    Returns ModelIdPropertyType<TProps, ModelIdPropertyName>

  • set $modelId(newId: ModelIdPropertyType<TProps, ModelIdPropertyName>): void

  • Parameters

    Returns void

size

  • get size(): number

  • Returns number

    the number of (unique) elements in Set.

Methods

[iterator]

  • "[iterator]"(): SetIterator<V>

  • Returns SetIterator<V>

add

  • add(value: V): this

  • Appends a new element with a specified value to the end of the Set.

    Parameters

    • value: V

    Returns this

clear

  • clear(): void

  • Returns void

delete

  • delete(value: V): boolean

  • Removes a specified value from the Set.

    Parameters

    • value: V

    Returns boolean

    Returns true if an element in the Set existed and has been removed, or false if the element does not exist.

difference

  • difference<U>(other: ReadonlySetLike<U>): Set<V>

  • Type Parameters

    • U

    Parameters

    • other: ReadonlySetLike<U>

    Returns Set<V>

    a new Set containing all the elements in this Set which are not also in the argument.

entries

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

  • Returns an iterable of [v,v] pairs for every value v in the set.

    Returns SetIterator<[V, V]>

forEach

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

  • Executes a provided function once per each value in the Set object, in insertion order.

    Parameters

    • callbackfn: (value: V, value2: V, set: Set<V>) => void
    • OptionalthisArg: 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

    a boolean indicating whether an element with the specified value exists in the Set or not.

intersection

  • intersection<U>(other: ReadonlySetLike<U>): Set<V & U>

  • Type Parameters

    • U

    Parameters

    • other: ReadonlySetLike<U>

    Returns Set<V & U>

    a new Set containing all the elements which are both in this Set and in the argument.

isDisjointFrom

  • isDisjointFrom(other: ReadonlySetLike<unknown>): boolean

  • Parameters

    • other: ReadonlySetLike<unknown>

    Returns boolean

    a boolean indicating whether this Set has no elements in common with the argument.

isSubsetOf

  • isSubsetOf(other: ReadonlySetLike<unknown>): boolean

  • Parameters

    • other: ReadonlySetLike<unknown>

    Returns boolean

    a boolean indicating whether all the elements in this Set are also in the argument.

isSupersetOf

  • isSupersetOf(other: ReadonlySetLike<unknown>): boolean

  • Parameters

    • other: ReadonlySetLike<unknown>

    Returns boolean

    a boolean indicating whether all the elements in the argument are also in this Set.

keys

  • keys(): SetIterator<V>

  • Despite its name, returns an iterable of the values in the set.

    Returns SetIterator<V>

symmetricDifference

  • symmetricDifference<U>(other: ReadonlySetLike<U>): Set<V | U>

  • Type Parameters

    • U

    Parameters

    • other: ReadonlySetLike<U>

    Returns Set<V | U>

    a new Set containing all the elements which are in either this Set or in the argument, but not in both.

toString

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

  • Parameters

    • Optionaloptions: { withData?: boolean }

    Returns string

typeCheck

  • typeCheck(): null | TypeCheckError

  • 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.

union

  • union<U>(other: ReadonlySetLike<U>): Set<V | U>

  • Type Parameters

    • U

    Parameters

    • other: ReadonlySetLike<U>

    Returns Set<V | U>

    a new Set containing all the elements in this Set and also all the elements in the argument.

values

  • values(): SetIterator<V>

  • Returns an iterable of values in the set.

    Returns SetIterator<V>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods