Package @reatom/persist

@reatom/persist

Interfaces

PersistRecord<T>

Defined in: index.ts:14

Type Parameters

T

T = unknown

Properties

data

data: T

Defined in: index.ts:15

id

id: number

Defined in: index.ts:16

timestamp

timestamp: number

Defined in: index.ts:17

to

to: number

Defined in: index.ts:20

Time stamp after which the record is cleared.

version

version: number

Defined in: index.ts:18

---

PersistStorage

Defined in: index.ts:23

Properties

name

name: string

Defined in: index.ts:24

Methods

clear()?

optional clear(key): void | Promise<void>

Defined in: index.ts:27

Parameters

key

string

Returns

void | Promise<void>

get()

get(key): null | PersistRecord<unknown> | Promise<null | PersistRecord<unknown>>

Defined in: index.ts:25

Parameters

key

string

Returns

null | PersistRecord<unknown> | Promise<null | PersistRecord<unknown>>

set()

set(key, rec): void | Promise<void>

Defined in: index.ts:26

Parameters

key

string

rec

PersistRecord

Returns

void | Promise<void>

subscribe()?

optional subscribe(key, callback): Unsubscribe

Defined in: index.ts:28

Parameters

key

string

callback

(record) => void

Returns

Unsubscribe

---

SyncPersistStorage

Defined in: index.ts:34

Properties

name

name: string

Defined in: index.ts:35

Methods

clear()?

optional clear(key): void

Defined in: index.ts:38

Parameters

key

string

Returns

void

get()

get(key): null | PersistRecord<unknown>

Defined in: index.ts:36

Parameters

key

string

Returns

null | PersistRecord<unknown>

set()

set(key, rec): void

Defined in: index.ts:37

Parameters

key

string

rec

PersistRecord

Returns

void

subscribe()?

optional subscribe(key, callback): Unsubscribe

Defined in: index.ts:39

Parameters

key

string

callback

(record) => void

Returns

Unsubscribe

---

WithPersist()

Defined in: index.ts:78

WithPersist<T>(…args): Ext<T>

Defined in: index.ts:79

Type Parameters

T

T extends Atom<any, [any]>

Parameters

args

[string] | [WithPersistOptions<AtomState<T>>]

Returns

Ext<T>

---

WithPersistOptions<T>

Defined in: index.ts:45

Type Parameters

T

T

Properties

fromSnapshot()?

optional fromSnapshot: (snapshot, state?) => T

Defined in: index.ts:51

Custom snapshot deserializer.

Parameters

snapshot

unknown

state?

T

Returns

T

key

key: string

Defined in: index.ts:47

Key of the storage record.

migration()?

optional migration: (persistRecord) => T

Defined in: index.ts:56

A callback to call if the version of a stored snapshot is older than version option.

Parameters

persistRecord

PersistRecord

Returns

T

subscribe?

optional subscribe: boolean

Defined in: index.ts:62

Determines whether the atom is updated on storage updates.

Default Value

true

time?

optional time: number

Defined in: index.ts:69

Number of milliseconds from the snapshot creation time after which it will be deleted.

Default Value

MAX_SAFE_TIMEOUT

toSnapshot()?

optional toSnapshot: (state) => unknown

Defined in: index.ts:49

Custom snapshot serializer.

Parameters

state

T

Returns

unknown

version?

optional version: number

Defined in: index.ts:75

Version of the stored snapshot. Triggers migration.

Default Value

0

Functions

createMemStorage()

createMemStorage(__namedParameters): SyncPersistStorage & object

Defined in: index.ts:241

Parameters

__namedParameters

mutable?

boolean = true

name

string

snapshot?

Rec = {}

subscribe?

boolean = true

Returns

SyncPersistStorage & object

---

reatomPersist()

reatomPersist(storage): WithPersist & object

Defined in: index.ts:84

Parameters

storage

PersistStorage

Returns

WithPersist & object