Type Alias HealthStore

Storage-neutral Health persistence contract.

Implementations must use one logical record collection and preserve bounded paging so health monitoring can run safely in serverless or scheduled jobs.

type HealthStore = {
    createRecord(record: HealthRecordCreateInput): Promise<string>;
    deleteRecord(id: string): Promise<boolean>;
    listRecords(options?: HealthRecordListOptions): Promise<HealthRecordPage>;
    putRecord(id: string, record: HealthRecordPutInput): Promise<boolean>;
    readRecord(id: string): Promise<HealthRecord | undefined>;
    updateRecord(
        id: string,
        changes: HealthRecordUpdateInput,
    ): Promise<boolean>;
}

Implemented by

DriverHealthStore

Index

Methods

createRecord deleteRecord listRecords putRecord readRecord updateRecord

Methods

createRecord

createRecord(record: HealthRecordCreateInput): Promise<string>
Create a Health record and return its generated id.
Parameters
- record: HealthRecordCreateInput
Returns Promise<string>
- Defined in health/Types.ts:128

deleteRecord

deleteRecord(id: string): Promise<boolean>
Delete a Health record.
Parameters
- id: string
Returns Promise<boolean>
- Defined in health/Types.ts:139

listRecords

listRecords(options?: HealthRecordListOptions): Promise<HealthRecordPage>
List a bounded page of Health records.
Parameters
- Optionaloptions: HealthRecordListOptions
Returns Promise<HealthRecordPage>
- Defined in health/Types.ts:141

putRecord

putRecord(id: string, record: HealthRecordPutInput): Promise<boolean>
Write or replace a deterministic Health record id.
Parameters
- id: string
- record: HealthRecordPutInput
Returns Promise<boolean>
- Defined in health/Types.ts:130

readRecord

readRecord(id: string): Promise<HealthRecord | undefined>
Read a Health record, returning undefined when it does not exist.
Parameters
- id: string
Returns Promise<HealthRecord | undefined>
- Defined in health/Types.ts:132

updateRecord

updateRecord(id: string, changes: HealthRecordUpdateInput): Promise<boolean>
Update mutable fields on an existing Health record.
Parameters
- id: string
- changes: HealthRecordUpdateInput
Returns Promise<boolean>
- Defined in health/Types.ts:134