Skip to documentation
Docs navigation
Docs/IngestOptions
Types

IngestOptions

TypeScript contract for IngestOptions.

What it does

TypeScript contract for IngestOptions.

Use IngestOptions 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 IngestOptions {
  tags?: string[];
}

Fields and behavior

tags? (string[]) — Normalized metadata copied to topics and memories created by this ingestion.

Result

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

Example

example.ts
import type { IngestOptions } from "memo-grafter";

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

Important behavior

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