Class SyncStorage

The SyncStorage class is an abstraction to implement any synchronous storage API in an uniform way.

Aracna Reference

Hierarchy

Storage
- SyncStorage

Index

Constructors

constructor

new SyncStorage(
    name: string,
    clear: () => void,
    get: <T extends StorageItem>(key: string) => T,
    has: (key: string) => boolean,
    remove: (key: string) => void,
    set: <T extends StorageItem>(key: string, item: T) => void,
): SyncStorage
Parameters
- name: string
- clear: () => void
- get: <T extends StorageItem>(key: string) => T
- has: (key: string) => boolean
- remove: (key: string) => void
- set: <T extends StorageItem>(key: string, item: T) => void
Returns SyncStorage
Overrides Storage.constructor
- Defined in src/classes/sync-storage.ts:12

Properties

`Protected` `Readonly`_clear

_clear: Clear

`Protected` `Readonly`_get

_get: Get

`Protected` `Readonly`_has

_has: Has

`Protected` `Readonly`_remove

_remove: Remove

`Protected` `Readonly`_set

_set: Set

`Protected` `Readonly`name

name: string

The storage instance name.

Methods

clear

clear(): void | Error
Clears the storage, removing all the items.

Returns void | Error
Overrides Storage.clear
- Defined in src/classes/sync-storage.ts:26

`Protected`clear_

clear_(cleared: void | Error): void | Error
Parameters
- cleared: void | Error
Returns void | Error
Inherited from Storage.clear_
- Defined in src/classes/storage.ts:45

copy

copy<
    T1 extends StorageItem,
    T2 extends StorageTarget = StorageTarget,
    T extends StorageItem & StorageTarget = T1 & T2,
>(
    key: string,
    target: T2,
    keys?: (keyof T)[],
): void | Error
Copies an item from the storage to a target object. Optionally you can specify the keys of the item that you want to copy, if you don't specify any key the whole item will be copied.
Type Parameters
- T1 extends StorageItem
- T2 extends StorageTarget = StorageTarget
- T extends StorageItem & StorageTarget = T1 & T2
Parameters
- key: string
- target: T2
- Optionalkeys: (keyof T)[]
Returns void | Error
Overrides Storage.copy
- Defined in src/classes/sync-storage.ts:57

`Protected`copy_

copy_<
    T1 extends StorageItem,
    T2 extends StorageTarget,
    T extends StorageItem & StorageTarget,
>(
    key: string,
    target: T2,
    keys: (keyof T)[] | undefined,
    item: Error | T1,
): void | Error
Type Parameters
- T1 extends StorageItem
- T2 extends StorageTarget
- T extends StorageItem & StorageTarget
Parameters
- key: string
- target: T2
- keys: (keyof T)[] | undefined
- item: Error | T1
Returns void | Error
Inherited from Storage.copy_
- Defined in src/classes/storage.ts:131

get

get<T extends StorageItem>(key: string): Error | T
Retrieves an item from the storage.
Type Parameters
- T extends StorageItem
Parameters
- key: string
Returns Error | T
Overrides Storage.get
- Defined in src/classes/sync-storage.ts:33

`Protected`get_

get_<T extends StorageItem>(key: string, item: Error | T): Error | T
Type Parameters
- T extends StorageItem
Parameters
- key: string
- item: Error | T
Returns Error | T
Inherited from Storage.get_
- Defined in src/classes/storage.ts:54

getName

getName(): string
Returns the name of the instance.

Returns string
Inherited from Storage.getName
- Defined in src/classes/storage.ts:189

has

has<T extends StorageItem>(key: string, keys?: (keyof T)[]): boolean
Checks if an item exists in the storage. Optionally you can specify the keys of the item that you want to check, if you don't specify any key the whole item will be checked.
Type Parameters
- T extends StorageItem
Parameters
- key: string
- Optionalkeys: (keyof T)[]
Returns boolean
Overrides Storage.has
- Defined in src/classes/sync-storage.ts:69

`Protected`has_

has_<T extends StorageItem>(
keys: (keyof T)[] | undefined,
item: Error | T,
): boolean
Type Parameters
- T extends StorageItem
Parameters
- keys: (keyof T)[] | undefined
- item: Error | T
Returns boolean
Inherited from Storage.has_
- Defined in src/classes/storage.ts:159

remove

remove<T extends StorageItem>(key: string, keys?: (keyof T)[]): void | Error
Removes an item from the storage. Optionally you can specify the keys of the item that you want to remove, if you don't specify any key the whole item will be removed.
Type Parameters
- T extends StorageItem
Parameters
- key: string
- Optionalkeys: (keyof T)[]
Returns void | Error
Overrides Storage.remove
- Defined in src/classes/sync-storage.ts:41

`Protected`remove_

remove_(key: string, removed: void | Error): void | Error
Parameters
- key: string
- removed: void | Error
Returns void | Error
Inherited from Storage.remove_
- Defined in src/classes/storage.ts:65

`Protected`remove__

remove__<T extends StorageItem>(
    key: string,
    keys: (keyof T)[],
    item: Error | T,
): T | undefined
Type Parameters
- T extends StorageItem
Parameters
- key: string
- keys: (keyof T)[]
- item: Error | T
Returns T | undefined
Inherited from Storage.remove__
- Defined in src/classes/storage.ts:70

`Protected`remove___

remove___<T extends StorageItem>(
    key: string,
    item: T,
    set: void | Error,
): void | Error
Type Parameters
- T extends StorageItem
Parameters
- key: string
- item: T
- set: void | Error
Returns void | Error
Inherited from Storage.remove___
- Defined in src/classes/storage.ts:81

set

set<T extends StorageItem>(
    key: string,
    item: T,
    keys?: (keyof T)[],
): void | Error
Sets an item in the storage. Optionally you can specify the keys of the item that you want to set, if you don't specify any key the whole item will be set.
Type Parameters
- T extends StorageItem
Parameters
- key: string
- item: T
- Optionalkeys: (keyof T)[]
Returns void | Error
Overrides Storage.set
- Defined in src/classes/sync-storage.ts:49

`Protected`set_

set_<T extends StorageItem>(
    key: string,
    item: Error | T,
    set: void | Error,
): void | Error
Type Parameters
- T extends StorageItem
Parameters
- key: string
- item: Error | T
- set: void | Error
Returns void | Error
Inherited from Storage.set_
- Defined in src/classes/storage.ts:99

`Protected`set__

set__<T extends StorageItem>(
    item: T,
    keys: (keyof T)[],
    current: Error | T,
): Error | T
Type Parameters
- T extends StorageItem
Parameters
- item: T
- keys: (keyof T)[]
- current: Error | T
Returns Error | T
Inherited from Storage.set__
- Defined in src/classes/storage.ts:106

Class SyncStorage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SyncStorage

Properties

Protected Readonly_clear

Protected Readonly_get

Protected Readonly_has

Protected Readonly_remove

Protected Readonly_set

Protected Readonlyname

Methods

clear

Returns void | Error

Protectedclear_

Parameters

Returns void | Error

copy

Type Parameters

Parameters

Returns void | Error

Protectedcopy_

Type Parameters

Parameters

Returns void | Error

get

Type Parameters

Parameters

Returns Error | T

Protectedget_

Type Parameters

Parameters

Returns Error | T

getName

Returns string

has

Type Parameters

Parameters

Returns boolean

Protectedhas_

Type Parameters

Parameters

Returns boolean

remove

Type Parameters

Parameters

Returns void | Error

Protectedremove_

Parameters

Returns void | Error

Protectedremove__

Type Parameters

Parameters

Returns T | undefined

Protectedremove___

Type Parameters

Parameters

Returns void | Error

set

Type Parameters

Parameters

Returns void | Error

Protectedset_

Type Parameters

Parameters

Returns void | Error

Protectedset__

Type Parameters

Parameters

Returns Error | T

Settings

On This Page

`Protected` `Readonly`_clear

`Protected` `Readonly`_get

`Protected` `Readonly`_has

`Protected` `Readonly`_remove

`Protected` `Readonly`_set

`Protected` `Readonly`name

`Protected`clear_

`Protected`copy_

`Protected`get_

`Protected`has_

`Protected`remove_

`Protected`remove__

`Protected`remove___

`Protected`set_

`Protected`set__