apiReferenceRecordToAgentDocumentFUNCTION
Added in v1.0.1Source
Signature
export declare function apiReferenceRecordToAgentDocument(
record: {
breadcrumbs: readonly {
current: boolean;
href?: string;
label: string
}[];
categories: readonly {
collapsed: boolean;
id: string;
label: string;
order: number
}[];
declarations: readonly {
category?: string;
categoryId: string;
description?: string;
descriptionParts?: readonly {
code?: boolean;
external?: boolean;
href?: string;
kind: "text" | "link";
text: string
}[];
examples?: readonly {
code: string;
language?: string;
name?: string
}[];
id: string;
introductionVersion?: string;
kind: "function" | "type" | "const" | "class" | "interface" | "variable" | "namespace";
link?: {
external: boolean;
href: string;
label?: string
};
name: string;
signature: string;
source?: {
endLine?: number;
file: string;
line?: number;
repositoryUrl: string;
revision: string
}
}[];
displayName: string;
exportCount: number;
introductionVersion?: string;
link?: {
external: boolean;
href: string;
label?: string
};
module: string;
packageDescription?: string;
packageExports?: readonly string[];
packageId: string;
packageName: string;
packagePrivate?: boolean;
packageSourceUrl?: string;
source?: {
endLine?: number;
file: string;
line?: number;
repositoryUrl: string;
revision: string
};
summary?: string;
summaryParts?: readonly {
code?: boolean;
external?: boolean;
href?: string;
kind: "text" | "link";
text: string
}[];
version: string
}
): { content: string; context?: string; description?: string; id: string; kind: "article" | "api-module" | "component"; metadata?: { [key: string]: unknown }; source?: { endLine?: number; file: string; line?: number; repositoryUrl: string; revision: string }; title: string; url: string; version?: string };