Class MemoryAdapter<T>

In-memory collection adapter intended for tests and demos.

Type Parameters

T extends Record<string, any>

Implements

SourceAdapter<T>

Index

Constructors

Methods

clear create delete getAllDocuments getStatus subscribe update

Constructors

constructor

new MemoryAdapter<T extends Record<string, any>>(
keyField?: string,
initialDocs?: T[],
): MemoryAdapter<T>
Type Parameters
- T extends Record<string, any>
Parameters
- keyField: string = "id"
- OptionalinitialDocs: T[]
Returns MemoryAdapter<T>
- Defined in adapters/memoryAdapter.ts:24

Methods

clear

clear(): void
Remove all stored documents.

Returns void
- Defined in adapters/memoryAdapter.ts:102

create

create(doc: T): Promise<void>
Create a document.
Parameters
- doc: T
Returns Promise<void>
Implementation of SourceAdapter.create
- Defined in adapters/memoryAdapter.ts:63

delete

delete(id: string): Promise<void>
Delete a document by id.
Parameters
- id: string
Returns Promise<void>
Implementation of SourceAdapter.delete
- Defined in adapters/memoryAdapter.ts:84

getAllDocuments

getAllDocuments(): T[]
Return all stored documents.

Returns T[]
- Defined in adapters/memoryAdapter.ts:97

getStatus

getStatus(): AdapterStatus
Get adapter status.

Returns AdapterStatus
Implementation of SourceAdapter.getStatus
- Defined in adapters/memoryAdapter.ts:92

subscribe(
    onUpdate: (docs: T[]) => void,
    onError: (error: Error) => void,
    query?: unknown,
): UnsubscribeFn
Subscribe to raw document updates and return an unsubscribe function.
Parameters
- onUpdate: (docs: T[]) => void
- onError: (error: Error) => void
- Optionalquery: unknown
Returns UnsubscribeFn
Implementation of SourceAdapter.subscribe
- Defined in adapters/memoryAdapter.ts:34

update

update(id: string, changes: Partial<T>): Promise<void>
Update a document by id.
Parameters
- id: string
- changes: Partial<T>
Returns Promise<void>
Implementation of SourceAdapter.update
- Defined in adapters/memoryAdapter.ts:74