IF Commons GitHub

stores/object/mod

Written to: 2 requirements: 2 proved, 0 partly, 0 failing, 0 with no test recorded. 0006-grc-evidence FR-001, 0006-grc-evidence FR-002

The object store (0006-grc-evidence FR-002): evidence in object storage, through a client of the shape { put(key, bytes), get(key), head(key), list(prefix) } that the host gives; it names no vendor and imports no client. Objects are keyed objects/<digest> and their evidence documents evidence/<digest>.json.

Source: commons/grc/src/stores/object/mod.ts

1 of 2 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

ObjectClienttypeno test imports it
type ObjectClient = {
  put(key: string, bytes: Uint8Array): Promise<void>;
  get(key: string): Promise<Uint8Array | undefined>;
  head(key: string): Promise<boolean>;
  list(prefix: string): Promise<readonly string[]>;
};

What the host gives.

objectStorefunction
function objectStore(client: ObjectClient, id?: string): EvidenceStore

A store over an object-storage client; id is the store's id in a registry.

Imported by 9 tests of the run (9 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.