LangChain API

Generated public TypeScript reference for @relkit/langchain.

For configuration and examples, read ai, tools, function tools.

Frontend usage

Observe an agent and send controls shows the client side of this capability.

Public imports

• @relkit/langchain — 298 exports
• @relkit/langchain/runtime — 20 exports
• @relkit/langchain/continuation-validation — 3 exports
• @relkit/langchain/testing — 19 exports

All exported APIs

Names link to their complete contracts. Re-exports share their original contract; legacy exports keep their separate identity. Examples link to the API’s inline sample, a maintained repository usage, or the shared module walkthrough.

client-contract-metadata.ts

Projects native agent and graph schemas into serializable client metadata; SDK-specific inspection remains inside this integration before the generic contract is published.

“./client-contract-metadata.types.js” (namespace export)

Re-exports all named exports from the “./client-contract-metadata.types.js” module.

Signature

export * from "./client-contract-metadata.types.js";

Source

agentClientContractMetadata

Builds native agent metadata for existing synchronous callers.

Throws

The original invalid metadata error.

Example

agentClientContractMetadata(options);

Signature

declare const agentClientContractMetadata: (
  options: AgentClientMetadataOptions,
) => AgentClientContractMetadata;

Source

agentClientContractMetadataEffect

Builds client contract metadata for a native agent.

Example

Effect.runSync(agentClientContractMetadataEffect(options));

Signature

declare const agentClientContractMetadataEffect: (
  options: AgentClientMetadataOptions,
) => Effect.Effect<AgentClientContractMetadata, AgentDefinitionFailure, never>;

Source

graphClientContractMetadata

Builds graph metadata for existing synchronous callers.

Throws

The original invalid graph metadata error.

Example

graphClientContractMetadata(options);

Signature

declare const graphClientContractMetadata: (
  options: GraphClientMetadataOptions,
) => AgentClientContractMetadata;

Source

graphClientContractMetadataEffect

Builds client contract metadata for a native graph.

Example

Effect.runSync(graphClientContractMetadataEffect(options));

Signature

declare const graphClientContractMetadataEffect: (
  options: GraphClientMetadataOptions,
) => Effect.Effect<AgentClientContractMetadata, GraphDefinitionFailure, never>;

Source

client-contract-metadata.types.ts

Projects native agent and graph schemas into serializable client metadata; SDK-specific inspection remains inside this integration before the generic contract is published. This companion preserves the native input and output types without starting runtime work.

AgentClientContractMetadata (interface)

Complete metadata needed to generate an agent client contract.

Signature

export interface AgentClientContractMetadata {
  readonly tools: readonly ClientToolMetadata[];
  readonly state: readonly ClientTypeField[];
  readonly events: readonly ClientEventMetadata[];
  readonly scopes: readonly ClientScopeMetadata[];
  readonly waiting: readonly ClientWaitingMetadata[];
}

Source

AgentClientMetadataOptions (interface)

Inputs for native agent client metadata.

Signature

export interface AgentClientMetadataOptions {
  readonly id: string;
  readonly tools: readonly AgentTool[];
  readonly middleware: readonly AgentMiddleware[];
  readonly client?: AgentClientPolicy;
  readonly subagents?: readonly SubagentMetadataSource[];
  readonly interruptOn?: Readonly<Record<string, unknown>>;
}

Source

ClientEventMetadata (type alias)

Client visible event schema or dynamic event marker.

Signature

type ClientEventMetadata = ClientTypeField | { readonly kind: "dynamic" };

Source

ClientScopeMetadata (interface)

Client visible agent, subagent, or graph node scope.

Signature

export interface ClientScopeMetadata {
  readonly kind: "agent" | "subagent" | "node" | "dynamic";
  readonly id?: string;
}

Source

ClientToolMetadata (type alias)

Client visible tool schema or dynamic tool marker.

Signature

type ClientToolMetadata =
  | {
      readonly id: string;
      readonly input: ClientSchemaMetadata;
      readonly output: ClientSchemaMetadata;
    }
  | { readonly kind: "dynamic" };

Source

ClientWaitingMetadata (interface)

Client visible continuation response schema.

Signature

export interface ClientWaitingMetadata {
  readonly scope: ClientScopeMetadata;
  readonly response: ClientSchemaMetadata;
}

Source

GraphClientMetadataOptions (interface)

Inputs for graph client metadata.

Signature

export interface GraphClientMetadataOptions {
  readonly id: string;
  readonly state: { readonly getJsonSchema: () => unknown };
  readonly client?: AgentClientPolicy;
  readonly workflow: GraphWorkflow;
}

Source

SubagentMetadataSource (interface)

Source of nested subagent scope identities.

Signature

export interface SubagentMetadataSource {
  readonly id: string;
  readonly subagents?: readonly SubagentMetadataSource[];
}

Source

client-contract-schema.ts

Inspects native schema adapters to describe client-visible inputs and outputs; unsupported shapes produce the existing contract errors before execution.

ClientSchemaMetadata

Signature

declare const ClientSchemaMetadata: ClientSchemaMetadata;

Source

ClientTypeField

Signature

declare const ClientTypeField: ClientTypeField;

Source

clientSchemaMetadata

Synchronously projects schema metadata for existing descriptor callers.

Example

const metadata = clientSchemaMetadata({ type: "string" });

Signature

declare const clientSchemaMetadata: (value: unknown) => ClientSchemaMetadata;

Source

clientSchemaMetadataEffect

Projects a schema-like value to safe client metadata.

Example

const metadata = Effect.runSync(clientSchemaMetadataEffect({ type: "string" }));

Signature

declare const clientSchemaMetadataEffect: (
  value: unknown,
) => Effect.Effect<ClientSchemaMetadata, never, never>;

Source

dynamicClientSchema

Marker for a schema that cannot be represented in the client contract.

Signature

declare const dynamicClientSchema: Readonly<{ kind: "dynamic" }>;

Source

mergeClientSchemas

Synchronously merges client schemas for existing descriptor callers.

Example

const schema = mergeClientSchemas([{ type: "object" }]);

Signature

declare const mergeClientSchemas: (values: readonly unknown[]) => ClientSchemaMetadata;

Source

mergeClientSchemasEffect

Merges projected object schemas while preserving input order.

Example

const schema = Effect.runSync(mergeClientSchemasEffect([{ type: "object" }]));

Signature

declare const mergeClientSchemasEffect: (
  values: ReadonlyArray<unknown>,
) => Effect.Effect<JsonValue, never, never>;

Source

selectedClientFields

Synchronously selects client fields for existing descriptor callers.

Example

const fields = selectedClientFields({ type: "object" }, ["name"]);

Signature

declare const selectedClientFields: (
  schema: ClientSchemaMetadata,
  keys?: readonly string[],
) => readonly ClientTypeField[];

Source

selectedClientFieldsEffect

Selects named client state fields from a projected object schema.

Example

const fields = Effect.runSync(selectedClientFieldsEffect({ type: "object" }, ["name"]));

Signature

declare const selectedClientFieldsEffect: (
  schema: ClientSchemaMetadata,
  keys?: ReadonlyArray<string> | undefined,
) => Effect.Effect<ReadonlyArray<ClientTypeField>, never, never>;

Source

continuation-validation.ts

Exposes graph identity and continuation validators to transport adapters without importing the agent execution barrel. Validation remains owned by its existing implementations and preserves their public failure and reply contracts.

isGraphDescriptor

Signature

declare const isGraphDescriptor: (value: unknown) => value is GraphDescriptor;

Source

validateGraphResumeInput

Signature

declare const validateGraphResumeInput: (
  descriptor: GraphDescriptor,
  requests: readonly AgentWaitingRequest[],
  value: unknown,
) => Promise<unknown>;

Source

validateNativeAgentResumeInput

Signature

declare const validateNativeAgentResumeInput: (
  requests: readonly AgentWaitingRequest[],
  value: unknown,
) => unknown;

Source

deepagent-bucket-backend.ts

Adapts a configured RELKIT bucket to the DeepAgents file backend, sharing the invocation scope and preserving bucket failures at the native adapter.

DeepAgentBucketBackendOptions

Signature

declare const DeepAgentBucketBackendOptions: DeepAgentBucketBackendOptions;

Source

createDeepAgentBucketBackend

Creates a backend for existing synchronous callers.

Throws

The original invalid bucket or prefix error.

Example

const backend = createDeepAgentBucketBackend(bucket);

Signature

declare const createDeepAgentBucketBackend: (
  bucket: DeepAgentBucketClient,
  options?: DeepAgentBucketBackendOptions,
) => BackendProtocolV2;

Source

createDeepAgentBucketBackendEffect

Builds a DeepAgents backend from a RELKIT bucket client.

Example

Effect.runSync(createDeepAgentBucketBackendEffect(bucket));

Signature

declare const createDeepAgentBucketBackendEffect: (
  bucket: DeepAgentBucketClient,
  options?: DeepAgentBucketBackendOptions | undefined,
) => Effect.Effect<
  Readonly<{
    ls: (path: string) => Promise<LsResult>;
    read: (path: string, offset?: number, limit?: number) => Promise<ReadResult>;
    readRaw: (path: string) => Promise<ReadRawResult>;
    write: (path: string, content: string) => Promise<WriteResult>;
    edit: (
      path: string,
      oldText: string,
      newText: string,
      replaceAll?: boolean,
    ) => Promise<EditResult>;
    grep: (
      pattern: string,
      path?: string | null,
      glob?: string | null,
      maxCount?: number | null,
    ) => Promise<GrepResult>;
    glob: (pattern: string, path?: string) => Promise<GlobResult>;
    delete: (path: string) => Promise<DeleteResult>;
    uploadFiles: (files: Array<[string, Uint8Array]>) => Promise<Array<FileUploadResponse>>;
    downloadFiles: (paths: string[]) => Promise<Array<FileDownloadResponse>>;
  }>,
  DeepAgentBucketFailure,
  never
>;

Source

deepagent-bucket-backend.types.ts

Configuration for a DeepAgents backend bound to a RELKIT bucket.

DeepAgentBucketBackendOptions (interface)

Configuration for a DeepAgents backend bound to a RELKIT bucket.

Signature

export interface DeepAgentBucketBackendOptions {
  /** Key prefix owned by this backend instance. */
  readonly prefix?: string;
}

Source

deepagent-bucket-client.types.ts

Bucket client and prefix bound to one DeepAgents backend.

DeepAgentBucketClient (interface)

IO operations required by the DeepAgents bucket bridge.

Signature

export interface DeepAgentBucketClient {
  readonly put: (
    key: string,
    bytes: Uint8Array,
    options?: {
      readonly contentType?: string;
      readonly metadata?: Readonly<Record<string, string>>;
    },
  ) => Promise<void>;
  readonly get: (key: string) => Promise<Uint8Array | undefined>;
  readonly head: (key: string) => Promise<DeepAgentBucketMetadata | undefined>;
  readonly delete: (key: string) => Promise<void>;
  readonly exists: (key: string) => Promise<boolean>;
  readonly list: (prefix?: string) => Promise<readonly string[]>;
}

Source

DeepAgentBucketContext (interface)

Bucket client and prefix bound to one DeepAgents backend.

Signature

export interface DeepAgentBucketContext {
  readonly bucket: DeepAgentBucketClient;
  readonly prefix: string;
}

Source

DeepAgentBucketMetadata (interface)

Metadata needed to expose a bucket object as a virtual file.

Signature

export interface DeepAgentBucketMetadata {
  readonly contentType?: string;
  readonly size?: number;
  readonly metadata?: Readonly<Record<string, string>>;
}

Source

deepagent-bucket-delete.ts

Deletes normalized DeepAgents file paths through the selected bucket service and reports native file-operation results without changing unrelated keys.

removeBucketPath

Removes a bucket path for existing DeepAgents Promise callers.

Throws

A cancellation or timeout failure from the bucket client.

Example

await removeBucketPath(context, "/notes");

Signature

declare const removeBucketPath: (
  context: DeepAgentBucketContext,
  path: string,
) => Promise<DeleteResult>;

Source

removeBucketPathEffect

Removes a virtual file or directory with at most eight bucket requests in flight.

Example

Effect.runPromise(Effect.provide(removeBucketPathEffect("/notes"), deepAgentBucketLayer(context)));

Signature

declare const removeBucketPathEffect: (
  path: string,
) => Effect.Effect<
  | { error: string; path?: never; filesUpdate?: never }
  | { path: string; filesUpdate: null; error?: never },
  DeepAgentBucketFailure,
  DeepAgentBucket
>;

Source

deepagent-bucket-error.ts

Translates bucket operation failures into the DeepAgents backend error format while retaining the affected operation and path.

DeepAgentBucketFailure (class)

Typed bucket validation or IO failure for DeepAgents operations.

Signature

declare class DeepAgentBucketFailure

Source

deepAgentBucketFailure

Captures a bucket error while preserving its original cause.

Example

deepAgentBucketFailure(new Error("not found"));

Signature

declare const deepAgentBucketFailure: (cause: unknown) => DeepAgentBucketFailure;

Source

deepagent-bucket-file-data.ts

Encodes and decodes DeepAgents file records stored in bucket objects, preserving file content and timestamps across backend operations.

putFileData

Writes a file for existing Promise callers.

Throws

The original bucket or path failure.

Example

await putFileData(context, "/a.md", "hi");

Signature

declare const putFileData: (
  context: DeepAgentBucketContext,
  path: string,
  content: string | Uint8Array,
) => Promise<void>;

Source

putFileDataEffect

Writes file content with timestamps from the Effect clock.

Example

Effect.runPromise(Effect.provide(putFileDataEffect("/a.md", "hi"), deepAgentBucketLayer(context)));

Signature

declare const putFileDataEffect: (
  path: string,
  content: string | Uint8Array<ArrayBufferLike>,
) => Effect.Effect<void, DeepAgentBucketFailure, DeepAgentBucket>;

Source

readFileData

Reads a file for existing Promise callers.

Throws

The original bucket or path failure.

Example

await readFileData(context, "/a.md");

Signature

declare const readFileData: (
  context: DeepAgentBucketContext,
  path: string,
) => Promise<DeepAgentBucketFileData | undefined>;

Source

readFileDataEffect

Reads bytes and metadata together from the current bucket service.

Example

Effect.runPromise(Effect.provide(readFileDataEffect("/a.md"), deepAgentBucketLayer(context)));

Signature

declare const readFileDataEffect: (path: string) => Effect.Effect<
  | {
      content: string | Uint8Array<ArrayBufferLike>;
      mimeType: string;
      created_at: string;
      modified_at: string;
    }
  | undefined,
  DeepAgentBucketFailure,
  DeepAgentBucket
>;

Source

deepagent-bucket-file-index.ts

Maintains the invocation file index used by bucket-backed listing and lookup; reads and mutations share the same backend state.

infoFor

Reads metadata for existing Promise callers.

Throws

The original bucket or path failure.

Example

await infoFor(context, "deepagents/a.md");

Signature

declare const infoFor: (
  context: DeepAgentBucketContext,
  key: string,
) => Promise<FileInfo | undefined>;

Source

infoForEffect

Reads metadata for one bucket key.

Example

Effect.runPromise(Effect.provide(infoForEffect("deepagents/a.md"), deepAgentBucketLayer(context)));

Signature

declare const infoForEffect: (
  key: string,
) => Effect.Effect<FileInfo | undefined, DeepAgentBucketFailure, DeepAgentBucket>;

Source

scopedKeys

Lists keys for existing Promise callers.

Throws

The original bucket or path failure.

Example

await scopedKeys(context, "/notes");

Signature

declare const scopedKeys: (
  context: DeepAgentBucketContext,
  path: string | null | undefined,
) => Promise<readonly string[]>;

Source

scopedKeysEffect

Lists sorted keys in a virtual file or directory.

Example

Effect.runPromise(Effect.provide(scopedKeysEffect("/notes"), deepAgentBucketLayer(context)));

Signature

declare const scopedKeysEffect: (
  path: string | null | undefined,
) => Effect.Effect<Array<string>, DeepAgentBucketFailure, DeepAgentBucket>;

Source

deepagent-bucket-files.ts

Collects bucket-backed file entries for native filesystem operations after path normalization, keeping metadata separate from fetched file content.

“./deepagent-bucket-files.types.js” (namespace export)

Re-exports all named exports from the “./deepagent-bucket-files.types.js” module.

Signature

export * from "./deepagent-bucket-files.types.js";

Source

bucketKey

Signature

declare const bucketKey: (context: DeepAgentBucketContext, path: string) => string;

Source

bucketKeyEffect

Signature

declare const bucketKeyEffect: (
  context: DeepAgentBucketContext,
  path: string,
) => Effect<string, DeepAgentBucketFailure, never>;

Source

createBucketContext

Signature

declare const createBucketContext: (
  bucket: DeepAgentBucketClient,
  prefix?: string,
) => DeepAgentBucketContext;

Source

createBucketContextEffect

Signature

declare const createBucketContextEffect: (
  bucket: DeepAgentBucketClient,
  prefix?: any,
) => Effect<
  Readonly<{ bucket: DeepAgentBucketClient; prefix: string }>,
  DeepAgentBucketFailure,
  never
>;

Source

errorMessage

Signature

declare const errorMessage: (cause: unknown) => string;

Source

errorMessageEffect

Signature

declare const errorMessageEffect: (cause: unknown) => Effect<string, never, never>;

Source

filePath

Signature

declare const filePath: (context: DeepAgentBucketContext, key: string) => string;

Source

filePathEffect

Signature

declare const filePathEffect: (
  context: DeepAgentBucketContext,
  key: string,
) => Effect<string, DeepAgentBucketFailure, never>;

Source

isControlFailure

Signature

declare const isControlFailure: (cause: unknown) => boolean;

Source

isControlFailureEffect

Signature

declare const isControlFailureEffect: (cause: unknown) => Effect<boolean, never, never>;

Source

isTextMimeType

Signature

declare const isTextMimeType: (mimeType: string) => boolean;

Source

isTextMimeTypeEffect

Signature

declare const isTextMimeTypeEffect: (mimeType: string) => Effect<boolean, never, never>;

Source

normalizedPage

Signature

declare const normalizedPage: (
  offset?: number,
  limit?: number,
) => { offset: number; limit: number };

Source

normalizedPageEffect

Signature

declare const normalizedPageEffect: (
  offset: number,
  limit: number,
) => Effect<{ offset: number; limit: number }, never, never>;

Source

virtualPath

Signature

declare const virtualPath: (value: string, directory?: boolean) => string;

Source

virtualPathEffect

Signature

declare const virtualPathEffect: (
  value: string,
  directory?: any,
) => Effect<string, DeepAgentBucketFailure, never>;

Source

deepagent-bucket-files.types.ts

Collects bucket-backed file entries for native filesystem operations after path normalization, keeping metadata separate from fetched file content. This companion preserves the native input and output types without starting runtime work.

“./deepagent-bucket-client.types.js” (namespace export)

Re-exports all named exports from the “./deepagent-bucket-client.types.js” module.

Signature

export * from "./deepagent-bucket-client.types.js";

Source

DeepAgentBucketFileData (type alias)

DeepAgents file payload that carries a concrete MIME type.

Signature

type DeepAgentBucketFileData = Extract<FileData, { readonly mimeType: string }>;

Source

deepagent-bucket-format.ts

Formats bucket file records into the native DeepAgents listing and content shapes consumed by backend callers.

errorMessage

Reads a failure message for existing synchronous callers.

Example

errorMessage(error);

Signature

declare const errorMessage: (cause: unknown) => string;

Source

errorMessageEffect

Reads a failure message without requiring an Error instance.

Example

Effect.runSync(errorMessageEffect(error));

Signature

declare const errorMessageEffect: (cause: unknown) => Effect.Effect<string, never, never>;

Source

isControlFailure

Classifies a control failure for existing synchronous callers.

Example

isControlFailure(error);

Signature

declare const isControlFailure: (cause: unknown) => boolean;

Source

isControlFailureEffect

Classifies cancellation and timeout control failures.

Example

Effect.runSync(isControlFailureEffect(error));

Signature

declare const isControlFailureEffect: (cause: unknown) => Effect.Effect<boolean, never, never>;

Source

isTextMimeType

Checks a text MIME type for existing synchronous callers.

Example

isTextMimeType("text/plain");

Signature

declare const isTextMimeType: (mimeType: string) => boolean;

Source

isTextMimeTypeEffect

Checks whether a MIME type should be decoded as text.

Example

Effect.runSync(isTextMimeTypeEffect("text/plain"));

Signature

declare const isTextMimeTypeEffect: (mimeType: string) => Effect.Effect<boolean, never, never>;

Source

normalizedPage

Normalizes paging for existing synchronous callers.

Example

normalizedPage(0, 500);

Signature

declare const normalizedPage: (
  offset?: number,
  limit?: number,
) => { offset: number; limit: number };

Source

normalizedPageEffect

Normalizes paging arguments to nonnegative integers.

Example

Effect.runSync(normalizedPageEffect(0, 500));

Signature

declare const normalizedPageEffect: (
  offset: number,
  limit: number,
) => Effect.Effect<{ offset: number; limit: number }, never, never>;

Source

deepagent-bucket-glob.ts

Matches normalized bucket paths against DeepAgents glob patterns so search traverses only the backend’s visible file namespace.

compileGlob

Validates and normalizes a user glob without changing match semantics.

Signature

declare const compileGlob: (pattern: string) => string;

Source

globFiles

Finds files for existing DeepAgents Promise callers.

Throws

A cancellation or timeout failure from the bucket client.

Example

await globFiles(context, "*.md", "/notes");

Signature

declare const globFiles: (
  context: DeepAgentBucketContext,
  pattern: string,
  path?: string,
) => Promise<GlobResult>;

Source

globFilesEffect

Finds matching bucket files and orders them by modification time.

Example

Effect.runPromise(Effect.provide(globFilesEffect("*.md"), deepAgentBucketLayer(context)));

Signature

declare const globFilesEffect: (
  pattern: string,
  path?: any,
) => Effect.Effect<{ files: Array<FileInfo> }, DeepAgentBucketFailure, DeepAgentBucket>;

Source

deepagent-bucket-grep.ts

Searches bucket file content for native grep requests and projects matching lines into DeepAgents results.

grepFiles

Searches text files for existing DeepAgents Promise callers.

Throws

A cancellation or timeout failure from the bucket client.

Example

await grepFiles(context, "TODO", "/notes", "*.md", 10);

Signature

declare const grepFiles: (
  context: DeepAgentBucketContext,
  pattern: string,
  path?: string | null,
  globPattern?: string | null,
  maxCount?: number | null,
) => Promise<GrepResult>;

Source

grepFilesEffect

Searches text files in key order and stops as soon as the match cap is exceeded.

Example

Effect.runPromise(Effect.provide(grepFilesEffect("TODO"), deepAgentBucketLayer(context)));

Signature

declare const grepFilesEffect: (
  pattern: string,
  path?: string | null | undefined,
  globPattern?: string | null | undefined,
  maxCount?: number | null | undefined,
) => Effect.Effect<
  | { matches: Array<GrepMatch>; truncated: boolean }
  | { matches: Array<GrepMatch>; truncated?: never },
  DeepAgentBucketFailure,
  DeepAgentBucket
>;

Source

deepagent-bucket-path.ts

Normalizes native file paths into scoped bucket keys and rejects paths that would escape the configured backend prefix.

bucketKey

Converts a virtual path to a bucket key for synchronous callers.

Throws

The original invalid path error.

Example

bucketKey(context, "/readme.md");

Signature

declare const bucketKey: (context: DeepAgentBucketContext, path: string) => string;

Source

bucketKeyEffect

Converts a virtual path to its bucket key.

Example

Effect.runSync(bucketKeyEffect(context, "/readme.md"));

Signature

declare const bucketKeyEffect: (
  context: DeepAgentBucketContext,
  path: string,
) => Effect.Effect<string, DeepAgentBucketFailure, never>;

Source

createBucketContext

Creates a bucket context for existing synchronous callers.

Throws

The original invalid bucket or prefix error.

Example

createBucketContext(bucket, "agents");

Signature

declare const createBucketContext: (
  bucket: DeepAgentBucketClient,
  prefix?: string,
) => DeepAgentBucketContext;

Source

createBucketContextEffect

Validates a bucket client and creates its private prefix context.

Example

Effect.runSync(createBucketContextEffect(bucket));

Signature

declare const createBucketContextEffect: (
  bucket: DeepAgentBucketClient,
  prefix?: any,
) => Effect.Effect<
  Readonly<{ bucket: DeepAgentBucketClient; prefix: string }>,
  DeepAgentBucketFailure,
  never
>;

Source

filePath

Converts a scoped bucket key for existing synchronous callers.

Throws

Error for a key outside the context prefix.

Example

filePath(context, "agents/readme.md");

Signature

declare const filePath: (context: DeepAgentBucketContext, key: string) => string;

Source

filePathEffect

Converts a scoped bucket key to a virtual path.

Example

Effect.runSync(filePathEffect(context, "agents/readme.md"));

Signature

declare const filePathEffect: (
  context: DeepAgentBucketContext,
  key: string,
) => Effect.Effect<string, DeepAgentBucketFailure, never>;

Source

virtualPath

Normalizes a virtual path for existing synchronous callers.

Throws

Error for empty, unsafe, or traversing paths.

Example

virtualPath("docs/readme.md");

Signature

declare const virtualPath: (value: string, directory?: boolean) => string;

Source

virtualPathEffect

Normalizes a virtual backend path and rejects traversal.

Example

Effect.runSync(virtualPathEffect("/docs/readme.md"));

Signature

declare const virtualPathEffect: (
  value: string,
  directory?: any,
) => Effect.Effect<string, DeepAgentBucketFailure, never>;

Source

deepagent-bucket-read.ts

Reads normalized native files from the selected bucket, applying the backend’s content and missing-file conventions.

readBucket

Reads a file for existing DeepAgents Promise callers.

Throws

A cancellation or timeout failure from the bucket client.

Example

await readBucket(context, "/a.md", 0, 50);

Signature

declare const readBucket: (
  context: DeepAgentBucketContext,
  path: string,
  offset?: number,
  limit?: number,
) => Promise<ReadResult>;

Source

readBucketEffect

Reads a paged text file or an unmodified binary payload.

Example

Effect.runPromise(Effect.provide(readBucketEffect("/a.md", 0, 50), deepAgentBucketLayer(context)));

Signature

declare const readBucketEffect: (
  path: string,
  offset?: any,
  limit?: any,
) => Effect.Effect<
  | { error: string; content?: never; mimeType?: never }
  | { content: string | Uint8Array<ArrayBufferLike>; mimeType: string; error?: never }
  | {
      nextOffset?: number;
      content: string;
      mimeType: string;
      totalLines: number;
      startLine: number;
      endLine: number;
      error?: never;
    },
  DeepAgentBucketFailure,
  DeepAgentBucket
>;