Class ArraySet<V>

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

Type Parameters

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

new ArraySet<V>(
 data: ModelPropsToTransformedCreationData<
 {
 $modelId: ModelIdProp<string> & {
 typedAs<T extends string>(): ModelIdProp<T>;
 };
 items: OptionalModelProp<any[]>;
 },
 >,
): ArraySet<V>
Type Parameters
- V
Parameters
- data: ModelPropsToTransformedCreationData<
 {
 $modelId: ModelIdProp<string> & {
 typedAs<T extends string>(): ModelIdProp<T>;
 };
 items: OptionalModelProp<any[]>;
 },
 >
Returns ArraySet<V>
Inherited from Model({ [modelIdKey]: idProp, items: tProp(typesArray(typesUnchecked<any>()), () => []), // will be properly checked by types.arraySet(subType) }).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>
Inherited from Model({ [modelIdKey]: idProp, items: tProp(typesArray(typesUnchecked<any>()), () => []), // will be properly checked by types.arraySet(subType) }).$modelId
set $modelId(newId: ModelIdPropertyType<TProps, ModelIdPropertyName>): void
Parameters
- newId: ModelIdPropertyType<TProps, ModelIdPropertyName>
Returns void
Inherited from Model({ [modelIdKey]: idProp, items: tProp(typesArray(typesUnchecked<any>()), () => []), // will be properly checked by types.arraySet(subType) }).$modelId

size

get size(): number
Returns number
the number of (unique) elements in Set.

Implementation of Set.size

Methods

[iterator]

"[iterator]"(): SetIterator<V>
Returns SetIterator<V>
Implementation of Set.[iterator]

add

add(value: V): this
Appends a new element with a specified value to the end of the Set.
Parameters
- value: V
Returns this
Implementation of Set.add

clear

clear(): void
Returns void
Implementation of Set.clear

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.

Implementation of Set.delete

difference

difference(other: ReadonlySetLike): Set<V>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<V>
a new Set containing all the elements in this Set which are not also in the argument.

Implementation of Set.difference

entries

entries(): SetIterator<[V, V]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns SetIterator<[V, V]>
Implementation of Set.entries

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
Implementation of Set.forEach

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
Inherited from Model({ [modelIdKey]: idProp, items: tProp(typesArray(typesUnchecked<any>()), () => []), // will be properly checked by types.arraySet(subType) }).getRefId

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.

Implementation of Set.has

intersection

intersection(other: ReadonlySetLike): Set<V & U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<V & U>
a new Set containing all the elements which are both in this Set and in the argument.

Implementation of Set.intersection

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.

Implementation of Set.isDisjointFrom

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.

Implementation of Set.isSubsetOf

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.

Implementation of Set.isSupersetOf

keys

keys(): SetIterator<V>
Despite its name, returns an iterable of the values in the set.

Returns SetIterator<V>
Implementation of Set.keys

symmetricDifference

symmetricDifference(other: ReadonlySetLike): Set<V | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
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.

Implementation of Set.symmetricDifference

toString

toString(options?: { withData?: boolean }): string
Parameters
- Optionaloptions: { withData?: boolean }
Returns string
Inherited from Model({ [modelIdKey]: idProp, items: tProp(typesArray(typesUnchecked<any>()), () => []), // will be properly checked by types.arraySet(subType) }).toString

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.

Inherited from Model({ [modelIdKey]: idProp, items: tProp(typesArray(typesUnchecked<any>()), () => []), // will be properly checked by types.arraySet(subType) }).typeCheck

union

union(other: ReadonlySetLike): Set<V | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<V | U>
a new Set containing all the elements in this Set and also all the elements in the argument.

Implementation of Set.union

values

values(): SetIterator<V>
Returns an iterable of values in the set.

Returns SetIterator<V>
Implementation of Set.values

Class ArraySet<V>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ArraySet<V>

Properties

[fromSnapshotOverrideTypeSymbol]

[modelIdPropertyNameSymbol]

[propsTypeSymbol]

[toSnapshotOverrideTypeSymbol]

Readonly[toStringTag]

Readonly$

Readonly$modelType

items

Accessors

$modelId

Returns ModelIdPropertyType<TProps, ModelIdPropertyName>

Parameters

Returns void

size

Returns number

Methods

[iterator]

Returns SetIterator<V>

add

Parameters

Returns this

clear

Returns void

delete

Parameters

Returns boolean

difference

Type Parameters

Parameters

Returns Set<V>

entries

Returns SetIterator<[V, V]>

forEach

Parameters

Returns void

getRefId

Returns undefined | string

has

Parameters

Returns boolean

intersection

Type Parameters

Parameters

Returns Set<V & U>

isDisjointFrom

Parameters

Returns boolean

isSubsetOf

Parameters

Returns boolean

isSupersetOf

Parameters

Returns boolean

keys

Returns SetIterator<V>

symmetricDifference

Type Parameters

Parameters

Returns Set<V | U>

toString

Parameters

Returns string

typeCheck

Returns null | TypeCheckError

union

`Readonly`[toStringTag]

`Readonly`$

`Readonly`$modelType