Class StorageAccessor

constructor

• new StorageAccessor(
      storage: IStorage,
      opt?: StorageAccessorOptions,
  ): StorageAccessor

  Parameters

  • storage: IStorage
  • Optionalopt: StorageAccessorOptions

  Returns StorageAccessor

Readonlyoptions

Readonlystorage

deleteSerializationCloneObject

• deleteSerializationCloneObject(): this

  Returns this

fork

• fork(storage?: null | IStorage, opt?: StorageAccessorOptions): StorageAccessor

  Parameters

  • Optionalstorage: null | IStorage
  • Optionalopt: StorageAccessorOptions

  Returns StorageAccessor

removeEmptyFields

• removeEmptyFields(): this

  Returns this

set

• set<S extends IStorage | IStorageArray>(
      key: string,
      value: undefined | null | S,
      opt?: { clone?: boolean },
  ): this

  Type Parameters

  • S extends IStorage | IStorageArray

  Parameters

  • key: string
  • value: undefined | null | S
  • Optionalopt: { clone?: boolean }

  Returns this

setArray

• setArray<V = unknown>(
      key: string,
      value: undefined | null | V[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Type Parameters

  • V = unknown

  Parameters

  • key: string
  • value: undefined | null | V[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setArrayIfNotEmpty

• setArrayIfNotEmpty<T>(
      key: string,
      value: undefined | null | T[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Type Parameters

  • T

  Parameters

  • key: string
  • value: undefined | null | T[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setBinary

• setBinary(key: string, value: undefined | null | string): this

  Parameters

  • key: string
  • value: undefined | null | string

  Returns this

setBinaryIfNotDefault

• setBinaryIfNotDefault(
      key: string,
      value: undefined | null | string,
      defaultValue?: undefined | null | string,
  ): this

  Parameters

  • key: string
  • value: undefined | null | string
  • defaultValue: undefined | null | string = null

  Returns this

setBoolean

• setBoolean(key: string, value: undefined | null | boolean): this

  Parameters

  • key: string
  • value: undefined | null | boolean

  Returns this

setBooleanIfNotDefault

• setBooleanIfNotDefault(
      key: string,
      value: undefined | null | boolean,
      defaultValue?: undefined | null | boolean,
  ): this

  Parameters

  • key: string
  • value: undefined | null | boolean
  • defaultValue: undefined | null | boolean = null

  Returns this

setDateTime

• setDateTime(key: string, value: undefined | null | string): this

  Parameters

  • key: string
  • value: undefined | null | string

  Returns this

setDateTimeArray

• setDateTimeArray(
      key: string,
      value: undefined | null | string[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Parameters

  • key: string
  • value: undefined | null | string[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setDateTimeIfNotDefault

• setDateTimeIfNotDefault(
      key: string,
      value: undefined | null | string,
      defaultValue?: undefined | null | string,
  ): this

  Parameters

  • key: string
  • value: undefined | null | string
  • defaultValue: undefined | null | string = null

  Returns this

setDecimal

• setDecimal(key: string, value: undefined | null | string): this

  Parameters

  • key: string
  • value: undefined | null | string

  Returns this

setDecimalArray

• setDecimalArray(
      key: string,
      value: undefined | null | string[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Parameters

  • key: string
  • value: undefined | null | string[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setDecimalIfNotDefault

• setDecimalIfNotDefault(
      key: string,
      value: undefined | null | string,
      defaultValue?: undefined | null | string,
  ): this

  Parameters

  • key: string
  • value: undefined | null | string
  • defaultValue: undefined | null | string = null

  Returns this

setDouble

• setDouble(key: string, value: undefined | null | number): this

  Parameters

  • key: string
  • value: undefined | null | number

  Returns this

setDoubleArray

• setDoubleArray(
      key: string,
      value: undefined | null | number[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Parameters

  • key: string
  • value: undefined | null | number[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setDoubleIfNotDefault

• setDoubleIfNotDefault(
      key: string,
      value: undefined | null | number,
      defaultValue?: undefined | null | number,
  ): this

  Parameters

  • key: string
  • value: undefined | null | number
  • defaultValue: undefined | null | number = null

  Returns this

setEnumAsString

• setEnumAsString(
      key: string,
      enumeration: object,
      value: undefined | null | number,
      options?: { lowerCase?: boolean },
  ): this

  Parameters

  • key: string
  • enumeration: object
  • value: undefined | null | number
  • Optionaloptions: { lowerCase?: boolean }

  Returns this

setEnumAsStringIfNotDefault

• setEnumAsStringIfNotDefault(
      key: string,
      enumeration: object,
      value: undefined | null | number,
      defaultValue?: undefined | null | number,
      options?: { lowerCase?: boolean },
  ): this

  Parameters

  • key: string
  • enumeration: object
  • value: undefined | null | number
  • defaultValue: undefined | null | number = null
  • Optionaloptions: { lowerCase?: boolean }

  Returns this

setFlags

• setFlags(key: string, enumeration: object, flags: number): this

  Parameters

  • key: string
  • enumeration: object
  • flags: number

  Returns this

setFlagsIfNotDefault

• setFlagsIfNotDefault(
      key: string,
      enumeration: object,
      flags: number,
      defaultValue?: number,
  ): this

  Parameters

  • key: string
  • enumeration: object
  • flags: number
  • defaultValue: number = 0

  Returns this

setFloat

• setFloat(key: string, value: undefined | null | number): this

  Parameters

  • key: string
  • value: undefined | null | number

  Returns this

setFloatArray

• setFloatArray(
      key: string,
      value: undefined | null | number[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Parameters

  • key: string
  • value: undefined | null | number[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setFloatIfNotDefault

• setFloatIfNotDefault(
      key: string,
      value: undefined | null | number,
      defaultValue?: undefined | null | number,
  ): this

  Parameters

  • key: string
  • value: undefined | null | number
  • defaultValue: undefined | null | number = null

  Returns this

setGuid

• setGuid(key: string, value: undefined | null | string): this

  Parameters

  • key: string
  • value: undefined | null | string

  Returns this

setGuidArray

• setGuidArray(
      key: string,
      value: undefined | null | string[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Parameters

  • key: string
  • value: undefined | null | string[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setGuidIfNotDefault

• setGuidIfNotDefault(
      key: string,
      value: undefined | null | string,
      defaultValue?: undefined | null | string,
  ): this

  Parameters

  • key: string
  • value: undefined | null | string
  • defaultValue: undefined | null | string = null

  Returns this

setGuidIfNotEmpty

• setGuidIfNotEmpty(key: string, value: undefined | null | string): this

  Parameters

  • key: string
  • value: undefined | null | string

  Returns this

setIfNotEmpty

• setIfNotEmpty<S extends IStorage | IStorageArray>(
      key: string,
      value: undefined | null | S,
      opt?: { clone?: boolean },
  ): this

  Type Parameters

  • S extends IStorage | IStorageArray

  Parameters

  • key: string
  • value: undefined | null | S
  • Optionalopt: { clone?: boolean }

  Returns this

setIfNotNull

• setIfNotNull<S extends IStorage | IStorageArray>(
      key: string,
      value: undefined | null | S,
      opt?: { clone?: boolean },
  ): this

  Type Parameters

  • S extends IStorage | IStorageArray

  Parameters

  • key: string
  • value: undefined | null | S
  • Optionalopt: { clone?: boolean }

  Returns this

setInt

• setInt(key: string, value: undefined | null | number): this

  Parameters

  • key: string
  • value: undefined | null | number

  Returns this

setIntArray

• setIntArray(
      key: string,
      value: undefined | null | number[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Parameters

  • key: string
  • value: undefined | null | number[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setIntIfNotDefault

• setIntIfNotDefault(
      key: string,
      value: undefined | null | number,
      defaultValue?: undefined | null | number,
  ): this

  Parameters

  • key: string
  • value: undefined | null | number
  • defaultValue: undefined | null | number = null

  Returns this

setLong

• setLong(key: string, value: undefined | null | number): this

  Parameters

  • key: string
  • value: undefined | null | number

  Returns this

setLongArray

• setLongArray(
      key: string,
      value: undefined | null | number[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Parameters

  • key: string
  • value: undefined | null | number[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setLongIfNotDefault

• setLongIfNotDefault(
      key: string,
      value: undefined | null | number,
      defaultValue?: undefined | null | number,
  ): this

  Parameters

  • key: string
  • value: undefined | null | number
  • defaultValue: undefined | null | number = null

  Returns this

setMap

• setMap<T = unknown>(
      key: string,
      m: undefined | null | Map<string, T>,
      itemFactory?: (x: T) => null | IStorage | IStorageArray,
  ): this

  Type Parameters

  • T = unknown

  Parameters

  • key: string
  • m: undefined | null | Map<string, T>
  • OptionalitemFactory: (x: T) => null | IStorage | IStorageArray

  Returns this

setMapAsArray

• setMapAsArray<T = unknown>(
      key: string,
      m: undefined | null | Map<string, T>,
      itemFactory?: (x: T) => IStorage | IStorageArray,
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Type Parameters

  • T = unknown

  Parameters

  • key: string
  • m: undefined | null | Map<string, T>
  • OptionalitemFactory: (x: T) => IStorage | IStorageArray
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setMapAsArrayIfNotEmpty

• setMapAsArrayIfNotEmpty<T>(
      key: string,
      map: null | Map<string, T> | IDictionary<T>,
      itemFactory: (x: T) => IStorage | IStorageArray,
      options?: StorageAccessorSetArrayOptions,
  ): this

  Type Parameters

  • T

  Parameters

  • key: string
  • map: null | Map<string, T> | IDictionary<T>
  • itemFactory: (x: T) => IStorage | IStorageArray
  • Optionaloptions: StorageAccessorSetArrayOptions

  Returns this

setMapIfNotEmpty

• setMapIfNotEmpty<T = unknown>(
      key: string,
      m: undefined | null | Map<string, T>,
      itemFactory?: (x: T) => null | IStorage | IStorageArray,
  ): this

  Type Parameters

  • T = unknown

  Parameters

  • key: string
  • m: undefined | null | Map<string, T>
  • OptionalitemFactory: (x: T) => null | IStorage | IStorageArray

  Returns this

setSerializationCloneObject

• setSerializationCloneObject(obj: unknown): this

  Parameters

  • obj: unknown

  Returns this

setString

• setString(key: string, value: undefined | null | string): this

  Parameters

  • key: string
  • value: undefined | null | string

  Returns this

setStringArray

• setStringArray(
      key: string,
      value: undefined | null | string[],
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Parameters

  • key: string
  • value: undefined | null | string[]
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setStringIfNotDefault

• setStringIfNotDefault(
      key: string,
      value: undefined | null | string,
      defaultValue?: undefined | null | string,
  ): this

  Parameters

  • key: string
  • value: undefined | null | string
  • defaultValue: undefined | null | string = null

  Returns this

setStringIfNotEmpty

• setStringIfNotEmpty(key: string, value: undefined | null | string): this

  Parameters

  • key: string
  • value: undefined | null | string

  Returns this

setTypedArray

• setTypedArray<
      V extends Primitive,
      T extends Boolean | FieldTypeAsString | FieldTypeAsNumber,
  >(
      key: string,
      value: undefined | null | V[],
      type: T,
      opt?: StorageAccessorSetArrayOptions,
  ): this

  Type Parameters

  • V extends Primitive
  • T extends Boolean | FieldTypeAsString | FieldTypeAsNumber

  Parameters

  • key: string
  • value: undefined | null | V[]
  • type: T
  • Optionalopt: StorageAccessorSetArrayOptions

  Returns this

setValue

• setValue<
      V extends Primitive,
      T extends Boolean | FieldTypeAsString | FieldTypeAsNumber,
  >(
      key: string,
      value: undefined | null | V,
      type: T,
  ): this

  Type Parameters

  • V extends Primitive
  • T extends Boolean | FieldTypeAsString | FieldTypeAsNumber

  Parameters

  • key: string
  • value: undefined | null | V
  • type: T

  Returns this

tryConvertFlags

• tryConvertFlags(key: string, enumeration: object): null | number

  Parameters

  • key: string
  • enumeration: object

  Returns null | number

tryConvertFlagsOrDefault

• tryConvertFlagsOrDefault(
      key: string,
      enumeration: object,
      defaultValue: number,
  ): null | number

  Parameters

  • key: string
  • enumeration: object
  • defaultValue: number

  Returns null | number

tryGet

• tryGet<T>(
      key: string,
      opt?: StorageAccessorGetOptions & { keepTypedField?: boolean },
  ): null | T

  Type Parameters

  • T

  Parameters

  • key: string
  • Optionalopt: StorageAccessorGetOptions & { keepTypedField?: boolean }

  Returns null | T

tryGetArray

• tryGetArray<T, S = IStorage>(
      key: string,
      itemFactory?: (storage: S, i: number) => T,
      opt?: StorageAccessorGetArrayOptions,
  ): null | T[]

  Type Parameters

  • T
  • S = IStorage

  Parameters

  • key: string
  • OptionalitemFactory: (storage: S, i: number) => T
  • Optionalopt: StorageAccessorGetArrayOptions

  Returns null | T[]

tryGetBinary

• tryGetBinary(key: string): null | string

  Parameters

  • key: string

  Returns null | string

tryGetBinaryOrDefault

• tryGetBinaryOrDefault(key: string, val?: string): null | string

  Parameters

  • key: string
  • val: string = ''

  Returns null | string

tryGetBoolean

• tryGetBoolean(key: string): null | boolean

  Parameters

  • key: string

  Returns null | boolean

tryGetBooleanFromString

• tryGetBooleanFromString(key: string): null | boolean

  Parameters

  • key: string

  Returns null | boolean

tryGetBooleanFromStringOrDefault

• tryGetBooleanFromStringOrDefault(key: string, val?: boolean): boolean

  Parameters

  • key: string
  • val: boolean = false

  Returns boolean

tryGetBooleanOrDefault

• tryGetBooleanOrDefault(key: string, val?: boolean): boolean

  Parameters

  • key: string
  • val: boolean = false

  Returns boolean

tryGetDateTime

• tryGetDateTime(key: string): null | string

  Parameters

  • key: string

  Returns null | string

tryGetDateTimeArray

• tryGetDateTimeArray(
      key: string,
      opt?: StorageAccessorGetArrayOptions,
  ): null | string[]

  Parameters

  • key: string
  • Optionalopt: StorageAccessorGetArrayOptions

  Returns null | string[]

tryGetDateTimeOrDefault

• tryGetDateTimeOrDefault(key: string, val?: string): string

  Parameters

  • key: string
  • val: string = DefaultValues.dateTime

  Returns string

tryGetDecimal

• tryGetDecimal(key: string): null | string

  Parameters

  • key: string

  Returns null | string

tryGetDecimalArray

• tryGetDecimalArray(
      key: string,
      opt?: StorageAccessorGetArrayOptions,
  ): null | string[]

  Parameters

  • key: string
  • Optionalopt: StorageAccessorGetArrayOptions

  Returns null | string[]

tryGetDecimalOrDefault

• tryGetDecimalOrDefault(key: string, val?: string): string

  Parameters

  • key: string
  • val: string = '0'

  Returns string

tryGetDictionary

• tryGetDictionary<T, S = IStorage>(
      key: string,
      itemFactory?: (key: string, storage: S) => T,
      opt?: StorageAccessorGetOptions & { lazy?: boolean } & DictionaryCreateOptions<
          T,
      >,
  ): null
  | IDictionary<T>

  Type Parameters

  • T
  • S = IStorage

  Parameters

  • key: string
  • OptionalitemFactory: (key: string, storage: S) => T
  • Optionalopt: StorageAccessorGetOptions & { lazy?: boolean } & DictionaryCreateOptions<T>

  Returns null | IDictionary<T>

tryGetDictionaryFromArray

• tryGetDictionaryFromArray<T, S = IStorage>(
      key: string,
      keyName: string,
      itemFactory: (key: string, storage: S) => T,
      opt?: StorageAccessorGetOptions & { omitTypedJsonListOptions?: boolean } & {
          ignoreCase?: boolean;
          lazy?: boolean;
      } & DictionaryCreateOptions<T>,
  ): null | IDictionary<T>

  Type Parameters

  • T
  • S = IStorage

  Parameters

  • key: string
  • keyName: string
  • itemFactory: (key: string, storage: S) => T
  • Optionalopt: StorageAccessorGetOptions & { omitTypedJsonListOptions?: boolean } & {
        ignoreCase?: boolean;
        lazy?: boolean;
    } & DictionaryCreateOptions<T>

    • OptionalomitTypedJsonListOptions?: boolean

      Игнорировать дополнительные опции для настройки списка с типизированным JSON.

    • OptionalignoreCase?: boolean

    • Optionallazy?: boolean

  Returns null | IDictionary<T>

tryGetDouble

• tryGetDouble(key: string): null | number

  Parameters

  • key: string

  Returns null | number

tryGetDoubleOrDefault

• tryGetDoubleOrDefault(key: string, val?: number): number

  Parameters

  • key: string
  • val: number = 0

  Returns number

tryGetEnumFromString

• tryGetEnumFromString(
      key: string,
      enumeration: object,
      options?: { ignoreCase?: boolean },
  ): null | number

  Parameters

  • key: string
  • enumeration: object
  • Optionaloptions: { ignoreCase?: boolean }

  Returns null | number

tryGetEnumFromStringOrDefault

• tryGetEnumFromStringOrDefault(
      key: string,
      enumeration: object,
      val?: number,
      options?: { ignoreCase?: boolean },
  ): number

  Parameters

  • key: string
  • enumeration: object
  • val: number = 0
  • Optionaloptions: { ignoreCase?: boolean }

  Returns number

tryGetFloat

• tryGetFloat(key: string): null | number

  Parameters

  • key: string

  Returns null | number

tryGetFloatOrDefault

• tryGetFloatOrDefault(key: string, val?: number): number

  Parameters

  • key: string
  • val: number = 0

  Returns number

tryGetGuid

• tryGetGuid(key: string): null | string

  Parameters

  • key: string

  Returns null | string

tryGetGuidArray

• tryGetGuidArray(
      key: string,
      opt?: StorageAccessorGetArrayOptions,
  ): null | string[]

  Parameters

  • key: string
  • Optionalopt: StorageAccessorGetArrayOptions

  Returns null | string[]

tryGetGuidOrDefault

• tryGetGuidOrDefault(key: string, val?: string): string

  Parameters

  • key: string
  • val: string = Guid.empty

  Returns string

tryGetInt

• tryGetInt(key: string): null | number

  Parameters

  • key: string

  Returns null | number

tryGetIntOrDefault

• tryGetIntOrDefault(key: string, val?: number): number

  Parameters

  • key: string
  • val: number = 0

  Returns number

tryGetList

• tryGetList<T, S = IStorage>(
      key: string,
      itemFactory?: (storage: S, i: number) => T,
      opt?: StorageAccessorGetOptions & { omitTypedJsonListOptions?: boolean } & {
          lazy?: boolean;
      } & ListCreateOptions<T>,
  ): null | IList<T>

  Type Parameters

  • T
  • S = IStorage

  Parameters

  • key: string
  • OptionalitemFactory: (storage: S, i: number) => T
  • Optionalopt: StorageAccessorGetOptions & { omitTypedJsonListOptions?: boolean } & {
        lazy?: boolean;
    } & ListCreateOptions<T>

    • OptionalomitTypedJsonListOptions?: boolean

      Игнорировать дополнительные опции для настройки списка с типизированным JSON.

    • Optionallazy?: boolean

  Returns null | IList<T>

tryGetLong

• tryGetLong(key: string): null | number

  Parameters

  • key: string

  Returns null | number

tryGetLongOrDefault

• tryGetLongOrDefault(key: string, val?: number): number

  Parameters

  • key: string
  • val: number = 0

  Returns number

tryGetMap

• tryGetMap<T, S = IStorage>(
      key: string,
      itemFactory?: (key: string, storage: S) => T,
      opt?: StorageAccessorGetOptions,
  ): null | Map<string, T>

  Type Parameters

  • T
  • S = IStorage

  Parameters

  • key: string
  • OptionalitemFactory: (key: string, storage: S) => T
  • Optionalopt: StorageAccessorGetOptions

  Returns null | Map<string, T>

tryGetMapFromArray

• tryGetMapFromArray<T, S = IStorage>(
      key: string,
      keyName: string,
      itemFactory: (key: string, storage: S) => T,
      opt?: StorageAccessorGetArrayOptions,
  ): null | Map<string, T>

  Type Parameters

  • T
  • S = IStorage

  Parameters

  • key: string
  • keyName: string
  • itemFactory: (key: string, storage: S) => T
  • Optionalopt: StorageAccessorGetArrayOptions

  Returns null | Map<string, T>

tryGetNumber

• tryGetNumber(key: string): null | number

  Parameters

  • key: string

  Returns null | number

tryGetNumberArray

• tryGetNumberArray(
      key: string,
      opt?: StorageAccessorGetArrayOptions,
  ): null | number[]

  Parameters

  • key: string
  • Optionalopt: StorageAccessorGetArrayOptions

  Returns null | number[]

tryGetNumberOrDefault

• tryGetNumberOrDefault(key: string, val?: number): number

  Parameters

  • key: string
  • val: number = 0

  Returns number

tryGetObject

• tryGetObject<T, S = IStorage>(
      key: string,
      itemFactory: (storage: S) => T,
      opt?: StorageAccessorGetOptions,
  ): null | T

  Type Parameters

  • T
  • S = IStorage

  Parameters

  • key: string
  • itemFactory: (storage: S) => T
  • Optionalopt: StorageAccessorGetOptions

  Returns null | T

tryGetSerializationCloneObject

• tryGetSerializationCloneObject<T>(): null | T

  Type Parameters

  • T

  Returns null | T

tryGetString

• tryGetString(key: string): null | string

  Parameters

  • key: string

  Returns null | string

tryGetStringArray

• tryGetStringArray(
      key: string,
      opt?: StorageAccessorGetArrayOptions,
  ): null | string[]

  Parameters

  • key: string
  • Optionalopt: StorageAccessorGetArrayOptions

  Returns null | string[]

tryGetStringOrDefault

• tryGetStringOrDefault(key: string, val?: string): string

  Parameters

  • key: string
  • val: string = ''

  Returns string

tryGetValue

• tryGetValue<T extends FieldType = FieldType>(
      key: string,
      type?: T,
  ): null | JsTypeFromFieldType<T>

  Type Parameters

  • T extends FieldType = FieldType

  Parameters

  • key: string
  • Optionaltype: T

  Returns null | JsTypeFromFieldType<T>

tryGetValueOrDefault

• tryGetValueOrDefault<T extends FieldType = FieldType>(
      key: string,
      val: JsTypeFromFieldType<T>,
      type?: T,
  ): JsTypeFromFieldType<T>

  Type Parameters

  • T extends FieldType = FieldType

  Parameters

  • key: string
  • val: JsTypeFromFieldType<T>
  • Optionaltype: T

  Returns JsTypeFromFieldType<T>