@codesoul-co/hypha-adapters-local / local-workspace-adapter

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/local-workspace-adapter.ts
• Exports: 3

Using this module

Use the Local workspace adapter module for declaring and enforcing workspace scope boundaries. It exports 1 class, 2 interfaces.

Import from the package entrypoint

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

import type {
  LocalWorkspaceAdapterOptions,
  LocalWorkspaceCaptureOptions,
} 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
LocalWorkspaceAdapter	class	new LocalWorkspaceAdapter(options: LocalWorkspaceAdapterOptions): LocalWorkspaceAdapter	Adapts a governed Workspace root to Local Process mutation evidence.
LocalWorkspaceAdapterOptions	interface	interface LocalWorkspaceAdapterOptions	Local Workspace Adapter Options interface with 4 public fields or methods.
LocalWorkspaceCaptureOptions	interface	interface LocalWorkspaceCaptureOptions	Local Workspace Capture Options interface with 1 public fields or methods.

LocalWorkspaceAdapter

Adapts a governed Workspace root to Local Process mutation evidence.

• Kind: class
• Import: import { LocalWorkspaceAdapter } from '@codesoul-co/hypha-adapters-local';
• Source module: local-workspace-adapter

Declaration

export declare class LocalWorkspaceAdapter {
    readonly workspaceRoot: string;
    constructor(options: LocalWorkspaceAdapterOptions);
    assertAvailable(): Promise<void>;
    capture(options?: LocalWorkspaceCaptureOptions): Promise<LocalWorkspaceSnapshot>;
    diff(before: LocalWorkspaceSnapshot, after: LocalWorkspaceSnapshot, detectedAt: string): FileMutation[];
}

Public members

Member	Kind	Signature	Description
assertAvailable	method	assertAvailable(): Promise<void>	Public method; parameters and return type are shown in the signature.
capture	method	capture(options?: LocalWorkspaceCaptureOptions): Promise<LocalWorkspaceSnapshot>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: LocalWorkspaceAdapterOptions): LocalWorkspaceAdapter	Creates an instance of this class.
diff	method	diff(before: LocalWorkspaceSnapshot, after: LocalWorkspaceSnapshot, detectedAt: string): FileMutation[]	Public method; parameters and return type are shown in the signature.
workspaceRoot	property	readonly workspaceRoot: string	Public property; its type, readonly modifier and optionality are shown in the signature.

LocalWorkspaceAdapterOptions

Local Workspace Adapter Options interface with 4 public fields or methods.

• Kind: interface
• Import: import type { LocalWorkspaceAdapterOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: local-workspace-adapter

Declaration

export interface LocalWorkspaceAdapterOptions {
    workspaceRoot: string;
    maxTrackedFiles?: number;
    maxTrackedBytes?: number;
    maxCaptureDurationMs?: number;
}

Contract members

Member	Kind	Signature	Description
maxCaptureDurationMs	property	maxCaptureDurationMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTrackedBytes	property	maxTrackedBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTrackedFiles	property	maxTrackedFiles?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
workspaceRoot	property	workspaceRoot: string	Public property; its type, readonly modifier and optionality are shown in the signature.

LocalWorkspaceCaptureOptions

Local Workspace Capture Options interface with 1 public fields or methods.

• Kind: interface
• Import: import type { LocalWorkspaceCaptureOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: local-workspace-adapter

Declaration

export interface LocalWorkspaceCaptureOptions {
    abortSignal?: AbortSignal;
}

Contract members

Member	Kind	Signature	Description
abortSignal	property	abortSignal?: AbortSignal	Public property; its type, readonly modifier and optionality are shown in the signature.