Constructors
constructor
Properties
Readonly
options
Readonly
storage
Methods
deleteSerializationCloneObject
deleteSerializationCloneObject(): this Returns this
fork
removeEmptyFields
removeEmptyFields(): this Returns this
set
set<S extends IStorage | IStorageArray>( key: string, value: undefined | null | S, opt?: { clone?: boolean },): this Parameters
- key: string
- value: undefined | null | S
Optional
opt: { clone?: boolean }
Returns this
setArray
setArray<V = unknown>( key: string, value: undefined | null | V[], opt?: StorageAccessorSetArrayOptions,): this Parameters
- key: string
- value: undefined | null | V[]
Optional
opt: StorageAccessorSetArrayOptions
Returns this
setBinary
setBinary(key: string, value: undefined | null | string): this Parameters
- key: string
- value: undefined | null | string
Returns this
setBoolean
setBoolean(key: string, value: undefined | null | boolean): this Parameters
- key: string
- value: undefined | null | boolean
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[]
Optional
opt: StorageAccessorSetArrayOptions
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[]
Optional
opt: StorageAccessorSetArrayOptions
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[]
Optional
opt: StorageAccessorSetArrayOptions
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
Optional
options: { lowerCase?: boolean }
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[]
Optional
opt: StorageAccessorSetArrayOptions
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[]
Optional
opt: StorageAccessorSetArrayOptions
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[]
Optional
opt: StorageAccessorSetArrayOptions
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[]
Optional
opt: StorageAccessorSetArrayOptions
Returns this
setMap
setMap<T = unknown>( key: string, m: undefined | null | Map<string, T>, itemFactory?: (x: T) => null | IStorage | IStorageArray,): this Returns this
setMapAsArray
setMapAsArray<T = unknown>( key: string, m: undefined | null | Map<string, T>, itemFactory?: (x: T) => IStorage | IStorageArray, opt?: StorageAccessorSetArrayOptions,): this Parameters
- key: string
- m: undefined | null | Map<string, T>
Optional
itemFactory: (x: T) => IStorage | IStorageArrayOptional
opt: StorageAccessorSetArrayOptions
Returns this
setSerializationCloneObject
setSerializationCloneObject(obj: unknown): this 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[]
Optional
opt: StorageAccessorSetArrayOptions
Returns this
setTypedArray
Parameters
- key: string
- value: undefined | null | V[]
- type: T
Optional
opt: StorageAccessorSetArrayOptions
Returns this
setValue
Parameters
- key: string
- value: undefined | null | V
- type: T
Returns this
tryGet
tryGet<T>( key: string, opt?: StorageAccessorGetOptions & { keepTypedField?: boolean },): null | T Parameters
- key: string
Optional
opt: StorageAccessorGetOptions & { keepTypedField?: boolean }
Returns null | T
tryGetArray
tryGetArray<T, S = IStorage>( key: string, itemFactory?: (storage: S, i: number) => T, opt?: StorageAccessorGetArrayOptions,): null | T[] Parameters
- key: string
Optional
itemFactory: (storage: S, i: number) => TOptional
opt: StorageAccessorGetArrayOptions
Returns null | T[]
tryGetBinary
tryGetBinary(key: string): null | 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 Returns null | boolean
tryGetBooleanFromString
tryGetBooleanFromString(key: string): null | boolean 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 Returns null | string
tryGetDateTimeArray
tryGetDateTimeArray( key: string, opt?: StorageAccessorGetArrayOptions,): null | string[] Parameters
- key: string
Optional
opt: 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 Returns null | string
tryGetDecimalArray
tryGetDecimalArray( key: string, opt?: StorageAccessorGetArrayOptions,): null | string[] Parameters
- key: string
Optional
opt: StorageAccessorGetArrayOptions
Returns null | string[]
tryGetDecimalOrDefault
tryGetDecimalOrDefault(key: string, val?: string): string Parameters
- key: string
- val: string = '0'
Returns string
tryGetDictionary
Parameters
- key: string
Optional
itemFactory: (key: string, storage: S) => TOptional
opt: StorageAccessorGetOptions & { lazy?: boolean } & DictionaryCreateOptions<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> Parameters
- key: string
- keyName: string
- itemFactory: (key: string, storage: S) => T
Optional
opt: StorageAccessorGetOptions & { omitTypedJsonListOptions?: boolean } & {
ignoreCase?: boolean;
lazy?: boolean;
} & DictionaryCreateOptions<T>Optional
omitTypedJsonListOptions?: boolean
Optional
ignoreCase?: boolean
Optional
lazy?: boolean
tryGetDouble
tryGetDouble(key: string): null | number 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
Optional
options: { 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
Optional
options: { ignoreCase?: boolean }
Returns number
tryGetFloat
tryGetFloat(key: string): null | number Returns null | number
tryGetFloatOrDefault
tryGetFloatOrDefault(key: string, val?: number): number Parameters
- key: string
- val: number = 0
Returns number
tryGetGuid
tryGetGuid(key: string): null | string Returns null | string
tryGetGuidArray
tryGetGuidArray( key: string, opt?: StorageAccessorGetArrayOptions,): null | string[] Parameters
- key: string
Optional
opt: 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 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> Parameters
- key: string
Optional
itemFactory: (storage: S, i: number) => TOptional
opt: StorageAccessorGetOptions & { omitTypedJsonListOptions?: boolean } & {
lazy?: boolean;
} & ListCreateOptions<T>Optional
omitTypedJsonListOptions?: boolean
Returns null | IList<T>
tryGetLong
tryGetLong(key: string): null | number 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> Parameters
- key: string
Optional
itemFactory: (key: string, storage: S) => TOptional
opt: 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> Parameters
- key: string
- keyName: string
- itemFactory: (key: string, storage: S) => T
Optional
opt: StorageAccessorGetArrayOptions
Returns null | Map<string, T>
tryGetNumber
tryGetNumber(key: string): null | number Returns null | number
tryGetNumberArray
tryGetNumberArray( key: string, opt?: StorageAccessorGetArrayOptions,): null | number[] Parameters
- key: string
Optional
opt: 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 Parameters
- key: string
- itemFactory: (storage: S) => T
Optional
opt: StorageAccessorGetOptions
Returns null | T
tryGetSerializationCloneObject
tryGetSerializationCloneObject<T>(): null | T Returns null | T
tryGetString
tryGetString(key: string): null | string Returns null | string
tryGetStringArray
tryGetStringArray( key: string, opt?: StorageAccessorGetArrayOptions,): null | string[] Parameters
- key: string
Optional
opt: StorageAccessorGetArrayOptions
Returns null | string[]
tryGetStringOrDefault
tryGetStringOrDefault(key: string, val?: string): string Parameters
- key: string
- val: string = ''
Returns string
tryGetValue
Parameters
- key: string
Optional
type: T
tryGetValueOrDefault
Игнорировать дополнительные опции для настройки списка с типизированным JSON.