Class InMemoryDataSource<T, K>`Abstract`

Shared behaviour for every source backed by a local collection.

Subclasses supply only where the records live, via read/write. All querying, identity assignment and mutation semantics are defined once here so the static and localStorage strategies cannot drift apart.

Type Parameters

T extends object
K extends keyof T

Hierarchy (View Summary)

InMemoryDataSource
- LocalStorageDataSource
- StaticDataSource

Implements

CrudDataSource<T, K>

Index

Constructors

`Protected`constructor

new InMemoryDataSource<T extends object, K extends string | number | symbol>(
key: K,
generateId?: IdGenerator<T, K>,
): InMemoryDataSource<T, K>
Type Parameters
- T extends object
- K extends string | number | symbol
Parameters
- key: K
- OptionalgenerateId: IdGenerator<T, K>
Returns InMemoryDataSource<T, K>
- Defined in lib/core/InMemoryDataSource.ts:21

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>
Implementation of CrudDataSource.create
- Defined in lib/core/InMemoryDataSource.ts:52

`Protected`decorate

decorate(_record: CrudDraft<T>, _operation: "create" | "update"): CrudDraft<T>
Hook for values a subclass stamps onto every write, such as timestamps. Returns nothing extra by default.
Parameters
- _record: CrudDraft<T>
- _operation: "create" | "update"
Returns CrudDraft<T>
- Defined in lib/core/InMemoryDataSource.ts:36

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>>
Implementation of CrudDataSource.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[]>
Implementation of CrudDataSource.listAll
- Defined in lib/core/InMemoryDataSource.ts:48

`Protected` `Abstract`read

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

Returns readonly T[]
- Defined in lib/core/InMemoryDataSource.ts:27

remove

remove(id: T[K]): Promise<void>
Delete the record at id.
Parameters
- id: T[K]
Returns Promise<void>
Implementation of CrudDataSource.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>
Implementation of CrudDataSource.update
- Defined in lib/core/InMemoryDataSource.ts:64

`Protected` `Abstract`write

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

Class InMemoryDataSource<T, K>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns InMemoryDataSource<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[]>

Protected Abstractread

Returns readonly T[]

remove

Parameters

Returns Promise<void>

update

Parameters

Returns Promise<T>

Protected Abstractwrite

Parameters

Returns void

Settings

On This Page

Class InMemoryDataSource<T, K>`Abstract`

`Protected`constructor

`Protected` `Readonly`generateId

`Protected` `Readonly`key

`Protected`decorate

`Protected` `Abstract`read

`Protected` `Abstract`write