@codesoul-co/hypha-adapters-local / in-memory-execution-artifact-store

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/in-memory-execution-artifact-store.ts
• Exports: 3

Using this module

Use the In memory execution artifact store module for persisting and reading data at this boundary. It exports 1 class, 2 interfaces.

Import from the package entrypoint

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

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

Usage patterns

• Use the 2 type/interface exports 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
InMemoryExecutionArtifactStore	class	new InMemoryExecutionArtifactStore(options?: InMemoryExecutionArtifactStoreOptions): InMemoryExecutionArtifactStore	In Memory Execution Artifact Store class with 12 public constructor or member entries; its exact declarations are listed below.
InMemoryExecutionArtifactStoreOptions	interface	interface InMemoryExecutionArtifactStoreOptions	In Memory Execution Artifact Store Options interface with 3 public fields or methods.
InMemoryExecutionArtifactStoreStats	interface	interface InMemoryExecutionArtifactStoreStats	In Memory Execution Artifact Store Stats interface with 3 public fields or methods.

InMemoryExecutionArtifactStore

In Memory Execution Artifact Store class with 12 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { InMemoryExecutionArtifactStore } from '@codesoul-co/hypha-adapters-local';
• Source module: in-memory-execution-artifact-store

Declaration

export declare class InMemoryExecutionArtifactStore implements ArtifactStoreProvider {
    readonly id: string;
    constructor(options?: InMemoryExecutionArtifactStoreOptions);
    capabilities(): Promise<ArtifactStoreCapabilities>;
    put(input: ArtifactPutRequest): Promise<ArtifactStorageRef>;
    get(input: ArtifactGetRequest, options?: ArtifactOperationOptions): Promise<ArtifactContent>;
    head(input: ArtifactStorageRef): Promise<ArtifactObjectMetadata | null>;
    exists(input: ArtifactStorageRef): Promise<boolean>;
    delete(input: ArtifactStorageRef): Promise<void>;
    copy(input: ArtifactCopyRequest): Promise<ArtifactStorageRef>;
    health(): Promise<ProviderHealth>;
    close(): Promise<void>;
    stats(): InMemoryExecutionArtifactStoreStats;
}

Public members

Member	Kind	Signature	Description
capabilities	method	capabilities(): Promise<ArtifactStoreCapabilities>	Public method; parameters and return type are shown in the signature.
close	method	close(): Promise<void>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options?: InMemoryExecutionArtifactStoreOptions): InMemoryExecutionArtifactStore	Creates an instance of this class.
copy	method	copy(input: ArtifactCopyRequest): Promise<ArtifactStorageRef>	Public method; parameters and return type are shown in the signature.
delete	method	delete(input: ArtifactStorageRef): Promise<void>	Public method; parameters and return type are shown in the signature.
exists	method	exists(input: ArtifactStorageRef): Promise<boolean>	Public method; parameters and return type are shown in the signature.
get	method	get(input: ArtifactGetRequest, options?: ArtifactOperationOptions): Promise<ArtifactContent>	Public method; parameters and return type are shown in the signature.
head	method	head(input: ArtifactStorageRef): Promise<ArtifactObjectMetadata | null>	Public method; parameters and return type are shown in the signature.
health	method	health(): Promise<ProviderHealth>	Public method; parameters and return type are shown in the signature.
id	property	readonly id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
put	method	put(input: ArtifactPutRequest): Promise<ArtifactStorageRef>	Public method; parameters and return type are shown in the signature.
stats	method	stats(): InMemoryExecutionArtifactStoreStats	Public method; parameters and return type are shown in the signature.

InMemoryExecutionArtifactStoreOptions

In Memory Execution Artifact Store Options interface with 3 public fields or methods.

• Kind: interface
• Import: import type { InMemoryExecutionArtifactStoreOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: in-memory-execution-artifact-store

Declaration

export interface InMemoryExecutionArtifactStoreOptions {
    id?: string;
    maxObjectBytes?: number;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
id	property	id?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
maxObjectBytes	property	maxObjectBytes?: number	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.

InMemoryExecutionArtifactStoreStats

In Memory Execution Artifact Store Stats interface with 3 public fields or methods.

• Kind: interface
• Import: import type { InMemoryExecutionArtifactStoreStats } from '@codesoul-co/hypha-adapters-local';
• Source module: in-memory-execution-artifact-store

Declaration

export interface InMemoryExecutionArtifactStoreStats {
    objects: number;
    blobs: number;
    storedBytes: number;
}

Contract members

Member	Kind	Signature	Description
blobs	property	blobs: number	Public property; its type, readonly modifier and optionality are shown in the signature.
objects	property	objects: number	Public property; its type, readonly modifier and optionality are shown in the signature.
storedBytes	property	storedBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.