Class StorageHelper`Helper`

Объект, содержащий вспомогательные методы для работы с IStorage и IStorageArray.

Hierarchy

StorageHelper

Methods

cleanEnumerableAndSetNullIfEmpty

cleanEnumerableAndSetNullIfEmpty(storage: IStorage<unknown>, key: string, deep?: boolean): boolean
Parameters
- storage: IStorage<unknown>
- key: string
- deep: boolean = true
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:437

clear

clear(storage: IStorage<unknown> | IStorageArray<unknown>): boolean
Parameters
- storage: IStorage<unknown> | IStorageArray<unknown>
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:384

clone

clone<T>(storage: T): T
Performs a deep copy of a storage object or primitive. Supports nested IStorage, IStorageArray, Primitive. All other types are transferred as is.

Returns
New storage object or primitive; null if cloning failed.

Remarks
An exception will be thrown if the copied object is not a storage object.
Type Parameters
- T extends IStorage<unknown> | IStorageArray<unknown> | Primitive
Parameters
- storage: T
  
  The storage object or primitive to be cloned.
Returns T
- Defined in @tessa/core/src/storage/storageHelper.ts:275

deepFreeze

deepFreeze(storage: undefined | null | IStorage<unknown> | IStorageArray<unknown>): boolean
Parameters
- storage: undefined | null | IStorage<unknown> | IStorageArray<unknown>
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:514

equals

equals(storage1?: null | IStorage<unknown> | IStorageArray<unknown>, storage2?: null | IStorage<unknown> | IStorageArray<unknown>): boolean
Parameters
- Optional storage1: null | IStorage<unknown> | IStorageArray<unknown>
- Optional storage2: null | IStorage<unknown> | IStorageArray<unknown>
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:400

isPrimitiveType

isPrimitiveType(value: unknown): value is Primitive
Parameters
- value: unknown
Returns value is Primitive
- Defined in @tessa/core/src/storage/storageHelper.ts:63

isStorage

isStorage<T>(storage: unknown): storage is IStorage<T>
Type Parameters
- T = unknown
Parameters
- storage: unknown
Returns storage is IStorage<T>
- Defined in @tessa/core/src/storage/storageHelper.ts:68

isStorageArray

isStorageArray<T>(storage: unknown): storage is IStorageArray<T>
Type Parameters
- T = unknown
Parameters
- storage: unknown
Returns storage is IStorageArray<T>
- Defined in @tessa/core/src/storage/storageHelper.ts:77

isSystemKey

isSystemKey(key: string): boolean
Parameters
- key: string
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:55

isUserKey

isUserKey(key: string): boolean
Parameters
- key: string
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:59

merge

merge<T>(source: T, target: T): void
Performs a deep merge of two storage objects. Supports nested IStorage, IStorageArray, Primitive. All other types are transferred as is.

Remarks
An exception will be thrown if the objects are not storage objects.
Type Parameters
- T extends IStorage<unknown> | IStorageArray<unknown>
Parameters
- source: T
  
  Source storage object.
- target: T
  
  Target storage object.
Returns void
- Defined in @tessa/core/src/storage/storageHelper.ts:318

removeEmptyEnumerableAndCheckIfEmpty

removeEmptyEnumerableAndCheckIfEmpty(obj: unknown, deep?: boolean): boolean
Parameters
- obj: unknown
- Optional deep: boolean
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:445
removeEmptyEnumerableAndCheckIfEmpty<T>(obj: unknown, isEmptyFunc: ((value: T) => boolean)): boolean
Type Parameters
- T = unknown
Parameters
- obj: unknown
- isEmptyFunc: ((value: T) => boolean)
  - - (value: T): boolean
    - Parameters
      
      value: T
      
      Returns boolean
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:446

setNullIfEmpty

setNullIfEmpty<T>(storage: IStorage<unknown>, key: string, cleanItemAndCheckIfEmptyFunc: ((item: T) => boolean)): boolean
Type Parameters
- T
Parameters
- storage: IStorage<unknown>
- key: string
- cleanItemAndCheckIfEmptyFunc: ((item: T) => boolean)
  - - (item: T): boolean
    - Parameters
      
      item: T
      
      Returns boolean
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:415

setNullIfEmptyEnumerable

setNullIfEmptyEnumerable(storage: IStorage<unknown>, key: string): boolean
Parameters
- storage: IStorage<unknown>
- key: string
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:433

setStorage

setStorage<T>(source: T, target: T): void
Type Parameters
- T extends IStorage<unknown> | IStorageArray<unknown>
Parameters
- source: T
- target: T
Returns void
- Defined in @tessa/core/src/storage/storageHelper.ts:353

tryClone

tryClone<T>(storage: undefined | null | T): T | null
Performs a deep copy of a storage object or primitive. Supports nested IStorage, IStorageArray, Primitive. All other types are transferred as is.

Returns
New storage object or primitive; null if cloning failed.
Type Parameters
- T extends IStorage<unknown> | IStorageArray<unknown> | Primitive
Parameters
- storage: undefined | null | T
  
  The storage object or primitive to be cloned.
Returns T | null
- Defined in @tessa/core/src/storage/storageHelper.ts:295

tryConvertToStorage

tryConvertToStorage<T>(obj: unknown): T | null
Type Parameters
- T extends IStorage<unknown> | IStorageArray<unknown> = IStorage<unknown>
Parameters
- obj: unknown
Returns T | null
- Defined in @tessa/core/src/storage/storageHelper.ts:539

tryDeleteKey

tryDeleteKey(storage: undefined | null | IStorage<unknown>, key: string): boolean
Parameters
- storage: undefined | null | IStorage<unknown>
- key: string
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:501

tryGet

tryGet<T>(storage: undefined | null | IStorage<unknown>, key: string, opt?: {
    checkValue?: ((value: unknown) => boolean);
    cloneContainer?: boolean;
    keepTypedField?: boolean;
}): T | null | undefined
Type Parameters
- T
Parameters
- storage: undefined | null | IStorage<unknown>
- key: string
- Optional opt: {
      checkValue?: ((value: unknown) => boolean);
      cloneContainer?: boolean;
      keepTypedField?: boolean;
  }
  - Optional checkValue?: ((value: unknown) => boolean)
    - (value: unknown): boolean
      
      Parameters
      
      value: unknown
      
      Returns boolean
  - Optional cloneContainer?: boolean
  - Optional keepTypedField?: boolean
Returns T | null | undefined
- Defined in @tessa/core/src/storage/storageHelper.ts:89

tryGetArray

tryGetArray<T, S>(storage: undefined | null | IStorage<unknown>, key: string, opt?: {
    checkValue?: ((value: unknown) => boolean);
    cloneContainer?: boolean;
    itemFactory?: ((storage: S, i: number) => T);
}): T[] | null | undefined
Type Parameters
- T
- S = IStorage<unknown>
Parameters
- storage: undefined | null | IStorage<unknown>
- key: string
- Optional opt: {
      checkValue?: ((value: unknown) => boolean);
      cloneContainer?: boolean;
      itemFactory?: ((storage: S, i: number) => T);
  }
  - Optional checkValue?: ((value: unknown) => boolean)
    - (value: unknown): boolean
      
      Parameters
      
      value: unknown
      
      Returns boolean
  - Optional cloneContainer?: boolean
  - Optional itemFactory?: ((storage: S, i: number) => T)
    - (storage: S, i: number): T
      
      Parameters
      
      storage: S
      
      i: number
      
      Returns T
Returns T[] | null | undefined
- Defined in @tessa/core/src/storage/storageHelper.ts:161

tryGetMap

tryGetMap<T, S>(storage: undefined | null | IStorage<unknown>, key: string, opt?: {
    checkValue?: ((value: unknown) => boolean);
    cloneContainer?: boolean;
    itemFactory?: ((key: string, storage: S) => T);
}): Map<string, T> | null | undefined
Type Parameters
- T
- S = IStorage<unknown>
Parameters
- storage: undefined | null | IStorage<unknown>
- key: string
- Optional opt: {
      checkValue?: ((value: unknown) => boolean);
      cloneContainer?: boolean;
      itemFactory?: ((key: string, storage: S) => T);
  }
  - Optional checkValue?: ((value: unknown) => boolean)
    - (value: unknown): boolean
      
      Parameters
      
      value: unknown
      
      Returns boolean
  - Optional cloneContainer?: boolean
  - Optional itemFactory?: ((key: string, storage: S) => T)
    - (key: string, storage: S): T
      
      Parameters
      
      key: string
      
      storage: S
      
      Returns T
Returns Map<string, T> | null | undefined
- Defined in @tessa/core/src/storage/storageHelper.ts:199

tryGetObject

tryGetObject<T, S>(storage: undefined | null | IStorage<unknown>, key: string, itemFactory: ((storage: S) => T), opt?: {
checkValue?: ((value: unknown) => boolean);
cloneContainer?: boolean;
}): T | null | undefined
Type Parameters
- T
- S = IStorage<unknown>
Parameters
- storage: undefined | null | IStorage<unknown>
- key: string
- itemFactory: ((storage: S) => T)
  - - (storage: S): T
    - Parameters
      
      storage: S
      
      Returns T
- Optional opt: {
  checkValue?: ((value: unknown) => boolean);
  cloneContainer?: boolean;
  }
  - Optional checkValue?: ((value: unknown) => boolean)
    - (value: unknown): boolean
      
      Parameters
      
      value: unknown
      
      Returns boolean
  - Optional cloneContainer?: boolean
Returns T | null | undefined
- Defined in @tessa/core/src/storage/storageHelper.ts:238

tryGetValue

tryGetValue<T>(storage: undefined | null | IStorage<unknown>, key: string, type?: T, throwOnFailValidation?: boolean): JsTypeFromFieldType<T> | null | undefined
Type Parameters
- T extends FieldType = FieldType
Parameters
- storage: undefined | null | IStorage<unknown>
- key: string
- Optional type: T
- throwOnFailValidation: boolean = false
Returns JsTypeFromFieldType<T> | null | undefined
- Defined in @tessa/core/src/storage/storageHelper.ts:126

tryMerge

tryMerge<T>(source: undefined | null | T, target: undefined | null | T): boolean
Performs a deep merge of two storage objects. Supports nested IStorage, IStorageArray, Primitive. All other types are transferred as is.

Returns
true if the merge was successful. false otherwise.
Type Parameters
- T extends IStorage<unknown> | IStorageArray<unknown>
Parameters
- source: undefined | null | T
  
  Source storage object.
- target: undefined | null | T
  
  Target storage object.
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:338

trySetStorage

trySetStorage<T>(source: undefined | null | T, target: undefined | null | T): boolean
Type Parameters
- T extends IStorage<unknown> | IStorageArray<unknown>
Parameters
- source: undefined | null | T
- target: undefined | null | T
Returns boolean
- Defined in @tessa/core/src/storage/storageHelper.ts:367

Class StorageHelperHelper

Hierarchy

Index

Variables

Methods

Methods

cleanEnumerableAndSetNullIfEmpty

Parameters

storage: IStorage<unknown>

key: string

deep: boolean = true

Returns boolean

clear

Parameters

storage: IStorage<unknown> | IStorageArray<unknown>

Returns boolean

clone

Returns

Remarks

Type Parameters

T extends IStorage<unknown> | IStorageArray<unknown> | Primitive

Parameters

storage: T

Returns T

deepFreeze

Parameters

storage: undefined | null | IStorage<unknown> | IStorageArray<unknown>

Returns boolean

equals

Parameters

Optional storage1: null | IStorage<unknown> | IStorageArray<unknown>

Optional storage2: null | IStorage<unknown> | IStorageArray<unknown>

Returns boolean

isPrimitiveType

Parameters

value: unknown

Returns value is Primitive

isStorage

Type Parameters

T = unknown

Parameters

storage: unknown

Returns storage is IStorage<T>

isStorageArray

Type Parameters

T = unknown

Parameters

storage: unknown

Returns storage is IStorageArray<T>

isSystemKey

Parameters

key: string

Returns boolean

isUserKey

Parameters

key: string

Returns boolean

merge

Remarks

Type Parameters

T extends IStorage<unknown> | IStorageArray<unknown>

Parameters

source: T

target: T

Returns void

removeEmptyEnumerableAndCheckIfEmpty

Parameters

obj: unknown

Optional deep: boolean

Returns boolean

Type Parameters

T = unknown

Parameters

obj: unknown

isEmptyFunc: ((value: T) => boolean)

Parameters

value: T

Returns boolean

Returns boolean

setNullIfEmpty

Class StorageHelper`Helper`

`Optional` storage1: null | IStorage<unknown> | IStorageArray<unknown>

`Optional` storage2: null | IStorage<unknown> | IStorageArray<unknown>

`Optional` deep: boolean

`Optional` opt: {
checkValue?: ((value: unknown) => boolean);
cloneContainer?: boolean;
keepTypedField?: boolean;
}

`Optional` checkValue?: ((value: unknown) => boolean)

`Optional` cloneContainer?: boolean

`Optional` keepTypedField?: boolean

`Optional` opt: {
checkValue?: ((value: unknown) => boolean);
cloneContainer?: boolean;
itemFactory?: ((storage: S, i: number) => T);
}

`Optional` checkValue?: ((value: unknown) => boolean)

`Optional` cloneContainer?: boolean