@codesoul-co/hypha-adapters-local / local-process-output-collector

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/local-process-output-collector.ts
• Exports: 5

Using this module

Use the Local process output collector module for using the public contracts and operations for this capability boundary. It exports 1 class, 3 interfaces, 1 type.

Import from the package entrypoint

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

import type {
  LocalProcessOutputAppendResult,
  LocalProcessOutputLimits,
  LocalProcessOutputSnapshot,
  LocalProcessOutputStream,
} from '@codesoul-co/hypha-adapters-local';

Usage patterns

• Use the 4 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
LocalProcessOutputCollector	class	new LocalProcessOutputCollector(limits: LocalProcessOutputLimits): LocalProcessOutputCollector	Collects bounded process output while accounting against raw bytes, not string length.
LocalProcessOutputAppendResult	interface	interface LocalProcessOutputAppendResult	Local Process Output Append Result interface with 1 public fields or methods.
LocalProcessOutputLimits	interface	interface LocalProcessOutputLimits	Local Process Output Limits interface with 3 public fields or methods.
LocalProcessOutputSnapshot	interface	interface LocalProcessOutputSnapshot	Local Process Output Snapshot interface with 6 public fields or methods.
LocalProcessOutputStream	type	type LocalProcessOutputStream = 'stdout' | 'stderr'	Public type alias for Local Process Output Stream; the declaration contains its complete type expression.

LocalProcessOutputCollector

Collects bounded process output while accounting against raw bytes, not string length.

• Kind: class
• Import: import { LocalProcessOutputCollector } from '@codesoul-co/hypha-adapters-local';
• Source module: local-process-output-collector

Declaration

export declare class LocalProcessOutputCollector {
    constructor(limits: LocalProcessOutputLimits);
    append(stream: LocalProcessOutputStream, chunk: Buffer): LocalProcessOutputAppendResult;
    snapshot(): LocalProcessOutputSnapshot;
}

Public members

Member	Kind	Signature	Description
append	method	append(stream: LocalProcessOutputStream, chunk: Buffer): LocalProcessOutputAppendResult	Public method; parameters and return type are shown in the signature.
constructor	constructor	(limits: LocalProcessOutputLimits): LocalProcessOutputCollector	Creates an instance of this class.
snapshot	method	snapshot(): LocalProcessOutputSnapshot	Public method; parameters and return type are shown in the signature.

LocalProcessOutputAppendResult

Local Process Output Append Result interface with 1 public fields or methods.

• Kind: interface
• Import: import type { LocalProcessOutputAppendResult } from '@codesoul-co/hypha-adapters-local';
• Source module: local-process-output-collector

Declaration

export interface LocalProcessOutputAppendResult {
    limitExceeded?: LocalProcessOutputStream | 'combined';
}

Contract members

Member	Kind	Signature	Description
limitExceeded	property	limitExceeded?: LocalProcessOutputStream | "combined"	Public property; its type, readonly modifier and optionality are shown in the signature.

LocalProcessOutputLimits

Local Process Output Limits interface with 3 public fields or methods.

• Kind: interface
• Import: import type { LocalProcessOutputLimits } from '@codesoul-co/hypha-adapters-local';
• Source module: local-process-output-collector

Declaration

export interface LocalProcessOutputLimits {
    maxStdoutBytes: number;
    maxStderrBytes: number;
    maxCombinedOutputBytes: number;
}

Contract members

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

LocalProcessOutputSnapshot

Local Process Output Snapshot interface with 6 public fields or methods.

• Kind: interface
• Import: import type { LocalProcessOutputSnapshot } from '@codesoul-co/hypha-adapters-local';
• Source module: local-process-output-collector

Declaration

export interface LocalProcessOutputSnapshot {
    stdout: string;
    stderr: string;
    capturedStdoutBytes: number;
    capturedStderrBytes: number;
    observedStdoutBytes: number;
    observedStderrBytes: number;
}

Contract members

Member	Kind	Signature	Description
capturedStderrBytes	property	capturedStderrBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
capturedStdoutBytes	property	capturedStdoutBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
observedStderrBytes	property	observedStderrBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
observedStdoutBytes	property	observedStdoutBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
stderr	property	stderr: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stdout	property	stdout: string	Public property; its type, readonly modifier and optionality are shown in the signature.

LocalProcessOutputStream

Public type alias for Local Process Output Stream; the declaration contains its complete type expression.

• Kind: type
• Import: import type { LocalProcessOutputStream } from '@codesoul-co/hypha-adapters-local';
• Source module: local-process-output-collector

Declaration

export type LocalProcessOutputStream = 'stdout' | 'stderr';