@codesoul-co/hypha-adapters-local / local-process-resource-accounting

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/local-process-resource-accounting.ts
• Exports: 2

Using this module

Use the Local process resource accounting module for using the public contracts and operations for this capability boundary. It exports 1 class, 1 interface.

Import from the package entrypoint

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

import type {
  LocalProcessResourceEvidence,
} 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
LocalProcessResourceAccountant	class	new LocalProcessResourceAccountant(): LocalProcessResourceAccountant	Reports only evidence the host Local Process adapter can actually observe.
LocalProcessResourceEvidence	interface	interface LocalProcessResourceEvidence	Local Process Resource Evidence interface with 2 public fields or methods.

LocalProcessResourceAccountant

Reports only evidence the host Local Process adapter can actually observe.

• Kind: class
• Import: import { LocalProcessResourceAccountant } from '@codesoul-co/hypha-adapters-local';
• Source module: local-process-resource-accounting

Declaration

export declare class LocalProcessResourceAccountant {
    account(result: LocalProcessRunResult): LocalProcessResourceEvidence;
}

Public members

Member	Kind	Signature	Description
account	method	account(result: LocalProcessRunResult): LocalProcessResourceEvidence	Public method; parameters and return type are shown in the signature.
constructor	constructor	(): LocalProcessResourceAccountant	Creates an instance of this class.

LocalProcessResourceEvidence

Local Process Resource Evidence interface with 2 public fields or methods.

• Kind: interface
• Import: import type { LocalProcessResourceEvidence } from '@codesoul-co/hypha-adapters-local';
• Source module: local-process-resource-accounting

Declaration

export interface LocalProcessResourceEvidence {
    usage: ExecutionResourceUsage;
    metadata: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
metadata	property	metadata: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
usage	property	usage: ExecutionResourceUsage	Public property; its type, readonly modifier and optionality are shown in the signature.