@codesoul-co/hypha-adapters-local / projection-store

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/projection-store.ts
• Exports: 2

Using this module

Use the Projection store module for persisting and reading data at this boundary. It exports 1 class, 1 interface.

Import from the package entrypoint

import {
  SQLiteProjectionStore,
} from '@codesoul-co/hypha-adapters-local';

import type {
  SQLiteProjectionStoreOptions,
} from '@codesoul-co/hypha-adapters-local';

Usage patterns

• Use the 1 type/interface export as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
SQLiteProjectionStore	class	new SQLiteProjectionStore<TState = unknown>(options: SQLiteProjectionStoreOptions): SQLiteProjectionStore<TState>	SQLite Projection Store class with 5 public constructor or member entries; its exact declarations are listed below.
SQLiteProjectionStoreOptions	interface	interface SQLiteProjectionStoreOptions	SQLite Projection Store Options interface with 2 public fields or methods.

SQLiteProjectionStore

SQLite Projection Store class with 5 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SQLiteProjectionStore } from '@codesoul-co/hypha-adapters-local';
• Source module: projection-store

Declaration

export declare class SQLiteProjectionStore<TState = unknown> implements ProjectionStore<TState> {
    constructor(options: SQLiteProjectionStoreOptions);
    get(projectionId: string, key: string): Promise<ProjectionRecord<TState> | null>;
    put(record: ProjectionRecord<TState>, expectedRevision?: number): Promise<void>;
    delete(projectionId: string, key: string): Promise<void>;
    close(): void;
}

Public members

Member	Kind	Signature	Description
close	method	close(): void	Public method; parameters and return type are shown in the signature.
constructor	constructor	<TState = unknown>(options: SQLiteProjectionStoreOptions): SQLiteProjectionStore<TState>	Creates an instance of this class.
delete	method	delete(projectionId: string, key: string): Promise<void>	Public method; parameters and return type are shown in the signature.
get	method	get(projectionId: string, key: string): Promise<ProjectionRecord<TState> | null>	Public method; parameters and return type are shown in the signature.
put	method	put(record: ProjectionRecord<TState>, expectedRevision?: number): Promise<void>	Public method; parameters and return type are shown in the signature.

SQLiteProjectionStoreOptions

SQLite Projection Store Options interface with 2 public fields or methods.

• Kind: interface
• Import: import type { SQLiteProjectionStoreOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: projection-store

Declaration

export interface SQLiteProjectionStoreOptions {
    filename: string;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
filename	property	filename: string	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.