Interface RecordStore

interface RecordStore {
    deleteRecord(id: string): void;
    getRecord(id: string): KaRecord | undefined;
    getRecordBytes(id: string): Buffer<ArrayBufferLike> | undefined;
    hasRecord(id: string): boolean;
    putRecord(record: KaRecord): void;
    recordIds(): string[];
}

Hierarchy (View Summary)

RecordStore
- Store

Index

Methods

deleteRecord getRecord getRecordBytes hasRecord putRecord recordIds

Methods

deleteRecord

deleteRecord(id: string): void
Parameters
- id: string
Returns void
- Defined in packages/lib-store/dist/src/store.d.ts:125

getRecord

getRecord(id: string): KaRecord | undefined
Parameters
- id: string
Returns KaRecord | undefined
- Defined in packages/lib-store/dist/src/store.d.ts:121

getRecordBytes

getRecordBytes(id: string): Buffer<ArrayBufferLike> | undefined
Canonical bytes of a stored record, exactly as they sit on disk.
Parameters
- id: string
Returns Buffer<ArrayBufferLike> | undefined
- Defined in packages/lib-store/dist/src/store.d.ts:123

hasRecord

hasRecord(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in packages/lib-store/dist/src/store.d.ts:120

putRecord

putRecord(record: KaRecord): void
Parameters
- record: KaRecord
Returns void
- Defined in packages/lib-store/dist/src/store.d.ts:124

recordIds

recordIds(): string[]
Every record id in the corpus, sorted.

Returns string[]
- Defined in packages/lib-store/dist/src/store.d.ts:127