Class TypedStorageArrayHelper

Hierarchy

  • TypedStorageArray

Methods

create from is readonlyEmpty

Methods

create

  • Создает массив-декоратор для объекта-хранилища и позволяющий прозрачно работать с TypedField значениями.

    Returns

    Строго типизированный декоратор для объекта-хранилища.

    Type Parameters

    Parameters

    • fieldType: T

      Тип значений, добавляемых в хранилище.

    • Optional options: {
          observable?: boolean;
      }

      Настройки массива-декоратора.

      • Optional observable?: boolean

        Флаг, включающий уведомления об изменении объектов. По умолчанию true.

    Returns TypedStorageArray<T, V>

from

  • Создает массив-декоратор для объекта-хранилища и позволяющий прозрачно работать с TypedField значениями.

    Returns

    Строго типизированный декоратор для объекта-хранилища.

    Remarks

    Если в качестве хранилища будет передан другой TypedStorageArray, то он будет возвращен как результат работы метода. Это может быть полезно для случаев, когда входящим значением может быть как TypedStorageArray так и обычный массив.

    Type Parameters

    Parameters

    • storage: unknown[] | readonly unknown[] | TypedStorageArray<T, V> | ReadonlyTypedStorageArray<T, V>

      Хранилище, декоратором для которого является создаваемый объект.

    • fieldType: T

      Тип значений, добавляемых в хранилище.

    • Optional options: {
          observable?: boolean;
      }

      Настройки массива-декоратора.

      • Optional observable?: boolean

        Флаг, включающий уведомления об изменении объектов. По умолчанию true.

    Returns TypedStorageArray<T, V>

is

  • Проверяет, что переданный объект является TypedStorageArray.

    Returns

    true если объект является TypedStorageArray; false в противном случае.

    Type Parameters

    Parameters

    • arr: unknown

      Объект, который требуется проверить.

    Returns arr is TypedStorageArray<T, V>

readonlyEmpty

Generated using TypeDoc