IngestTextOptions

TypeScript contract for IngestTextOptions.

What it does

TypeScript contract for IngestTextOptions.

Use IngestTextOptions to keep application code aligned with the values MemoGrafter accepts or returns at this boundary. It is a TypeScript-only contract and adds no runtime behavior.

Definition

TypeScript

interface IngestTextOptions {
  replace?: boolean;
  label?: string;
  source?: string;
}

Fields and behavior

replace? (boolean, default false) — Clear the target session graph before processing this text.

label? (string) — Supply a document/topic label instead of relying only on extraction.

source? (string) — Preserve an application-defined provenance label.

Result

A compile-time-only TypeScript contract with no runtime value.

Example

example.ts

import type { IngestTextOptions } from "memo-grafter";

function useValue(value: IngestTextOptions) {
  return value;
}

Important behavior

Use import type when the contract is not needed at runtime.