@codesoul-co/hypha-adapters-local / state-execution-claim-store

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

Using this module

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

Import from the package entrypoint

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

import type {
  SQLiteStateExecutionClaimStoreOptions,
} 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
SQLiteStateExecutionClaimStore	class	new SQLiteStateExecutionClaimStore(options: SQLiteStateExecutionClaimStoreOptions): SQLiteStateExecutionClaimStore	SQLite State Execution Claim Store class with 8 public constructor or member entries; its exact declarations are listed below.
SQLiteStateExecutionClaimStoreOptions	interface	interface SQLiteStateExecutionClaimStoreOptions	SQLite State Execution Claim Store Options interface with 3 public fields or methods.

SQLiteStateExecutionClaimStore

SQLite State Execution Claim Store class with 8 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SQLiteStateExecutionClaimStore } from '@codesoul-co/hypha-adapters-local';
• Source module: state-execution-claim-store

Declaration

export declare class SQLiteStateExecutionClaimStore implements StateExecutionClaimStore {
    constructor(options: SQLiteStateExecutionClaimStoreOptions);
    acquire(request: StateExecutionClaimAcquireRequest): Promise<StateExecutionClaim | null>;
    renew(request: StateExecutionClaimRenewRequest): Promise<StateExecutionClaim>;
    complete(request: StateExecutionClaimCompleteRequest): Promise<StateExecutionClaim>;
    release(request: StateExecutionClaimReleaseRequest): Promise<StateExecutionClaim>;
    get(scope: StateExecutionClaimScope, checkedAt?: string): Promise<StateExecutionClaim | null>;
    assertCurrent(request: StateExecutionClaimAssertionRequest): Promise<StateExecutionClaim>;
    close(): void;
}

Public members

Member	Kind	Signature	Description
acquire	method	acquire(request: StateExecutionClaimAcquireRequest): Promise<StateExecutionClaim | null>	Public method; parameters and return type are shown in the signature.
assertCurrent	method	assertCurrent(request: StateExecutionClaimAssertionRequest): Promise<StateExecutionClaim>	Public method; parameters and return type are shown in the signature.
close	method	close(): void	Public method; parameters and return type are shown in the signature.
complete	method	complete(request: StateExecutionClaimCompleteRequest): Promise<StateExecutionClaim>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: SQLiteStateExecutionClaimStoreOptions): SQLiteStateExecutionClaimStore	Creates an instance of this class.
get	method	get(scope: StateExecutionClaimScope, checkedAt?: string): Promise<StateExecutionClaim | null>	Public method; parameters and return type are shown in the signature.
release	method	release(request: StateExecutionClaimReleaseRequest): Promise<StateExecutionClaim>	Public method; parameters and return type are shown in the signature.
renew	method	renew(request: StateExecutionClaimRenewRequest): Promise<StateExecutionClaim>	Public method; parameters and return type are shown in the signature.

SQLiteStateExecutionClaimStoreOptions

SQLite State Execution Claim Store Options interface with 3 public fields or methods.

• Kind: interface
• Import: import type { SQLiteStateExecutionClaimStoreOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: state-execution-claim-store

Declaration

export interface SQLiteStateExecutionClaimStoreOptions {
    filename: string;
    runLeaseStore: Pick<RunLeaseStore, 'assertCurrent'>;
    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.
runLeaseStore	property	runLeaseStore: Pick<RunLeaseStore, "assertCurrent">	Public property; its type, readonly modifier and optionality are shown in the signature.