Class HttpSourceAdapter<T>

HTTP-backed source adapter for collection persistence and live updates.

Type Parameters

T extends Record<string, unknown>

Implements

SourceAdapter<T>

Index

Constructors

Methods

create delete getStatus subscribe update

Constructors

constructor

new HttpSourceAdapter<T extends Record<string, unknown>>(
config: HttpSourceAdapterConfig,
): HttpSourceAdapter<T>
Type Parameters
- T extends Record<string, unknown>
Parameters
- config: HttpSourceAdapterConfig
Returns HttpSourceAdapter<T>
- Defined in adapters/httpAdapter.ts:105

Methods

create

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

delete

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

getStatus

getStatus(): AdapterStatus
Get adapter status.

Returns AdapterStatus
Implementation of SourceAdapter.getStatus
- Defined in adapters/httpAdapter.ts:171

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/httpAdapter.ts:128

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/httpAdapter.ts:161