Class LocalStorageDataSource<T, K>

A source persisting to localStorage under a fixed key.

Reads go through storage on every call rather than through a cache, so a second tab writing the same key is picked up on the next query instead of being shadowed by stale in-memory state.

Storage is best-effort: a read that fails or returns malformed JSON falls back to the seed rather than throwing, since an unreadable cache should not take the table down. Writes that fail (quota, private mode) do throw - silently dropping a write the user believes succeeded is worse than an error.

Type Parameters

T extends object
K extends keyof T

Hierarchy (View Summary)

InMemoryDataSource<T, K>
- LocalStorageDataSource

Index

Constructors

constructor

new LocalStorageDataSource<T extends object, K extends string | number | symbol>(
    storageKey: string,
    key: K,
    seed?: readonly T[],
    generateId?: IdGenerator<T, K>,
): LocalStorageDataSource<T, K>
Type Parameters
- T extends object
- K extends string | number | symbol
Parameters
- storageKey: string
- key: K
- seed: readonly T[] = []
- OptionalgenerateId: IdGenerator<T, K>
Returns LocalStorageDataSource<T, K>
Overrides InMemoryDataSource.constructor
- Defined in lib/core/LocalStorageDataSource.ts:31

Properties

`Protected` `Readonly`generateId

generateId: IdGenerator<T, K>

Assigns the identity for newly created records.

`Protected` `Readonly`key

key: K

The property holding each record's identity.

Methods

create

create(draft: CrudDraft<T>): Promise<T>
Persist a new record and return it as stored, identity included.
Parameters
- draft: CrudDraft<T>
Returns Promise<T>
Inherited from InMemoryDataSource.create
- Defined in lib/core/InMemoryDataSource.ts:52

`Protected`decorate

decorate(_draft: CrudDraft<T>, operation: "create" | "update"): CrudDraft<T>
Stamps creation and modification times onto every write.
Parameters
- _draft: CrudDraft<T>
- operation: "create" | "update"
Returns CrudDraft<T>
Overrides InMemoryDataSource.decorate
- Defined in lib/core/LocalStorageDataSource.ts:67

list

list(query: CrudQuery<T>): Promise<CrudPage<T>>
Read one page. Implementations must apply filters before paginating.
Parameters
- query: CrudQuery<T>
Returns Promise<CrudPage<T>>
Inherited from InMemoryDataSource.list
- Defined in lib/core/InMemoryDataSource.ts:44

listAll

listAll(query: Omit<CrudQuery<T>, "page" | "pageSize">): Promise<readonly T[]>
Every record matching the query, ignoring pagination.

Exists so export can cover the whole result set rather than the current page. Optional: a source over an unbounded remote collection may have no safe way to honour it, and callers must degrade to list when absent.
Parameters
- query: Omit<CrudQuery<T>, "page" | "pageSize">
Returns Promise<readonly T[]>
Inherited from InMemoryDataSource.listAll
- Defined in lib/core/InMemoryDataSource.ts:48

`Protected`read

read(): readonly T[]
Current contents of the backing collection.

Returns readonly T[]
Overrides InMemoryDataSource.read
- Defined in lib/core/LocalStorageDataSource.ts:37

remove

remove(id: T[K]): Promise<void>
Delete the record at id.
Parameters
- id: T[K]
Returns Promise<void>
Inherited from InMemoryDataSource.remove
- Defined in lib/core/InMemoryDataSource.ts:84

update

update(id: T[K], draft: CrudDraft<T>): Promise<T>
Merge draft into the record at id and return the stored result.
Parameters
- id: T[K]
- draft: CrudDraft<T>
Returns Promise<T>
Inherited from InMemoryDataSource.update
- Defined in lib/core/InMemoryDataSource.ts:64

`Protected`write

write(records: readonly T[]): void
Replace the backing collection.
Parameters
- records: readonly T[]
Returns void
Overrides InMemoryDataSource.write
- Defined in lib/core/LocalStorageDataSource.ts:54

Class LocalStorageDataSource<T, K>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LocalStorageDataSource<T, K>

Properties

Protected ReadonlygenerateId

Protected Readonlykey

Methods

create

Parameters

Returns Promise<T>

Protecteddecorate

Parameters

Returns CrudDraft<T>

list

Parameters

Returns Promise<CrudPage<T>>

listAll

Parameters

Returns Promise<readonly T[]>

Protectedread

Returns readonly T[]

remove

Parameters

Returns Promise<void>

update

Parameters

Returns Promise<T>

Protectedwrite

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`generateId

`Protected` `Readonly`key

`Protected`decorate

`Protected`read

`Protected`write