0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-18 19:34:58 +00:00
ai/docs/reference/functions/normalizeSystemPrompts.md
github-actions[bot] 5701bf5184
docs: regenerate API documentation (#1141)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-18 19:53:35 +02:00

1.2 KiB

id title
normalizeSystemPrompts normalizeSystemPrompts

Function: normalizeSystemPrompts()

function normalizeSystemPrompts<TMetadata>(prompts): NormalizedSystemPrompt<TMetadata>[];

Defined in: packages/ai/src/system-prompts.ts:70

Normalise the public systemPrompts shape (Array<string | { content, metadata? }>) to a homogenous Array<{ content, metadata? }>. Adapters use this so they don't have to type-narrow string vs object inline.

Returns an empty array (never undefined) so callers can chain .map / .join without an extra null check.

Throws a TypeError (naming the offending index) if an object-form entry's content isn't a string. Public API boundary — callers reaching this function through as any / external JS would otherwise stream a literal "undefined" into the model's system prompt with no signal.

Type Parameters

TMetadata

TMetadata = unknown

Parameters

prompts

| readonly SystemPrompt<unknown>[] | undefined

Returns

NormalizedSystemPrompt<TMetadata>[]