@codesoul-co/hypha-adapters-local / local-filesystem-execution-artifact-store

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

Using this module

Use the Local filesystem execution artifact store module for persisting and reading data at this boundary. It exports 1 class, 3 interfaces.

Import from the package entrypoint

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

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

Usage patterns

• Use the 3 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
LocalFilesystemExecutionArtifactStore	class	new LocalFilesystemExecutionArtifactStore(options: LocalFilesystemExecutionArtifactStoreOptions): LocalFilesystemExecutionArtifactStore	Local Filesystem Execution Artifact Store class with 13 public constructor or member entries; its exact declarations are listed below.
LocalArtifactGarbageCollectionResult	interface	interface LocalArtifactGarbageCollectionResult	Local Artifact Garbage Collection Result interface with 2 public fields or methods.
LocalFilesystemExecutionArtifactStoreOptions	interface	interface LocalFilesystemExecutionArtifactStoreOptions	Local Filesystem Execution Artifact Store Options interface with 4 public fields or methods.
LocalFilesystemExecutionArtifactStoreStats	interface	interface LocalFilesystemExecutionArtifactStoreStats	Local Filesystem Execution Artifact Store Stats interface with 3 public fields or methods.

LocalFilesystemExecutionArtifactStore

Local Filesystem Execution Artifact Store class with 13 public constructor or member entries; its exact declarations are listed below.

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

Declaration

export declare class LocalFilesystemExecutionArtifactStore implements ArtifactStoreProvider {
    readonly id: string;
    constructor(options: LocalFilesystemExecutionArtifactStoreOptions);
    capabilities(): Promise<ArtifactStoreCapabilities>;
    put(input: ArtifactPutRequest, options?: ArtifactOperationOptions): 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(): Promise<LocalFilesystemExecutionArtifactStoreStats>;
    collectGarbage(): Promise<LocalArtifactGarbageCollectionResult>;
}

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.
collectGarbage	method	collectGarbage(): Promise<LocalArtifactGarbageCollectionResult>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: LocalFilesystemExecutionArtifactStoreOptions): LocalFilesystemExecutionArtifactStore	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, options?: ArtifactOperationOptions): Promise<ArtifactStorageRef>	Public method; parameters and return type are shown in the signature.
stats	method	stats(): Promise<LocalFilesystemExecutionArtifactStoreStats>	Public method; parameters and return type are shown in the signature.

LocalArtifactGarbageCollectionResult

Local Artifact Garbage Collection Result interface with 2 public fields or methods.

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

Declaration

export interface LocalArtifactGarbageCollectionResult {
    deletedBlobs: number;
    reclaimedBytes: number;
}

Contract members

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

LocalFilesystemExecutionArtifactStoreOptions

Local Filesystem Execution Artifact Store Options interface with 4 public fields or methods.

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

Declaration

export interface LocalFilesystemExecutionArtifactStoreOptions {
    id?: string;
    rootPath: 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.
rootPath	property	rootPath: string	Public property; its type, readonly modifier and optionality are shown in the signature.

LocalFilesystemExecutionArtifactStoreStats

Local Filesystem Execution Artifact Store Stats interface with 3 public fields or methods.

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

Declaration

export interface LocalFilesystemExecutionArtifactStoreStats {
    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.