collection-asset-documents.ts#

5 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

5 symbols 1 functions 4 interfaces 1 parameters 21 members 1 returns

Reference#

interfaceCollectionAssetDocumentDiagnosticActionable diagnostic scoped to one selected document and, when relevant, one r…6 members

Actionable diagnostic scoped to one selected document and, when relevant, one reference.

Signature

export interface CollectionAssetDocumentDiagnostic

View source

Members

Properties

Name	Type	Description
`code`	`CollectionAssetDocumentDiagnosticCode`
`documentPath`	`string`
`message`	`string`
`pagePath`optional	`string`
`reference`optional	`string`
`sourcePath`optional	`string`

interfaceCollectionAssetDocumentInputOne public Markdown or MDX document whose local references may publish files.4 members

One public Markdown or MDX document whose local references may publish files.

Signature

export interface CollectionAssetDocumentInput

View source

Members

Properties

Name	Type	Description
`ast`optional	`MarkdownNode`	Parsed mdast-compatible tree. Takes precedence over `source` when present.
`documentPath`	`string`	Markdown/MDX document path, relative to `root` or absolute within it.
`pagePath`	`string`	Public page path for resolving relative aliases such as `./cover.png`.
`source`optional	`string`	Markdown/MDX source. When omitted, `documentPath` is read from disk.

interfaceCollectionAssetDocumentReference extends CollectionAssetResolvedDocumentReferenceA local document reference included in the resulting asset plan.1 member

A local document reference included in the resulting asset plan.

Signature

export interface CollectionAssetDocumentReference extends CollectionAssetResolvedDocumentReference

View source

Members

Properties

Name	Type	Description
`publicPaths`	`string[]`

interfaceCollectionAssetResolvedDocumentReferenceA local document reference after resolving its source file and default alias.10 members

A local document reference after resolving its source file and default alias.

Signature

export interface CollectionAssetResolvedDocumentReference

View source

Members

Properties

Name	Type	Description
`attribute`optional	`string`
`documentPath`	`string`
`hash`	`string`
`nodeType`	`string`
`original`	`string`
`pagePath`	`string`
`pathname`	`string`
`publicPath`	`string`
`search`	`string`
`sourcePath`	`string`

planCollectionAssetsFromDocuments(input: PlanCollectionAssetsFromDocumentsInput): Promise<PlanCollectionAssetsFromDocumentsResult>

Plan content-addressed collection assets by following local references from hos…1 paramreturns Promise<PlanCollectionAssetsFromDocumentsResult>

Plan content-addressed collection assets by following local references from host-selected Markdown/MDX documents.

Signature

export async function planCollectionAssetsFromDocuments(input: PlanCollectionAssetsFromDocumentsInput): Promise<PlanCollectionAssetsFromDocumentsResult>

View source

Parameters

input PlanCollectionAssetsFromDocumentsInput

Returns

Promise<PlanCollectionAssetsFromDocumentsResult>