Class CustomDataSource<T, K>

Adapts a bag of consumer-supplied functions to the full interface.

Exists so the rest of the library can depend on CrudDataSource without null-checking each method at every call site; absent operations fail here with a message naming what is missing.

Type Parameters

T extends object
K extends keyof T

Implements

CrudDataSource<T, K>

Index

Constructors

constructor

Methods

create list listAll remove supports update

Constructors

constructor

new CustomDataSource<T extends object, K extends string | number | symbol>(
operations: CrudOperations<T, K>,
): CustomDataSource<T, K>
Type Parameters
- T extends object
- K extends string | number | symbol
Parameters
- operations: CrudOperations<T, K>
Returns CustomDataSource<T, K>
- Defined in lib/core/CustomDataSource.ts:39

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/CustomDataSource.ts:58

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/CustomDataSource.ts:48

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/CustomDataSource.ts:53

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/CustomDataSource.ts:68

supports

supports(operation: keyof CrudDataSource<T, K>): boolean
Whether an operation was supplied, so callers can hide unavailable UI.
Parameters
- operation: keyof CrudDataSource<T, K>
Returns boolean
- Defined in lib/core/CustomDataSource.ts:44

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/CustomDataSource.ts:63

Class CustomDataSource<T, K>

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CustomDataSource<T, K>

Methods

create

Parameters

Returns Promise<T>

list

Parameters

Returns Promise<CrudPage<T>>

listAll

Parameters

Returns Promise<readonly T[]>

remove

Parameters

Returns Promise<void>

supports

Parameters

Returns boolean

update

Parameters

Returns Promise<T>

Settings

On This Page