frontmatter-schemas.ts#

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

4 symbols 2 functions 1 interfaces 1 types 2 parameters 2 members 2 returns

Reference#

fndefineFrontmatterSchemas<const S extends FrontmatterSchemas>(schemas: S): SPreserve each glob's inferred input/output types without choosing a validation…1 paramreturns S

Preserve each glob's inferred input/output types without choosing a validation library.

Signature

export function defineFrontmatterSchemas<const S extends FrontmatterSchemas>(schemas: S): S

View source

Parameters

schemas S

Returns

S

fnfrontmatterJsonSchema(definition: FrontmatterSchema): Record<string, unknown> | undefinedInput JSON Schema describes the YAML authors write, before defaults or transfor…1 paramreturns Record<string, unknown> | undefined

Input JSON Schema describes the YAML authors write, before defaults or transforms.

Signature

export function frontmatterJsonSchema(definition: FrontmatterSchema): Record<string, unknown> | undefined

View source

Parameters

definition FrontmatterSchema

Returns

Record<string, unknown> | undefined

interfaceFrontmatterSchemaAdapter<S extends StandardSchemaV1 = StandardSchemaV1>Optional JSON shape for completions when a validator has no Standard JSON Schem…2 members

Optional JSON shape for completions when a validator has no Standard JSON Schema converter.

Signature

export interface FrontmatterSchemaAdapter<S extends StandardSchemaV1 = StandardSchemaV1>

View source

Members

Properties

Name	Type	Description
`jsonSchema`	`StandardJSONSchemaV1 \| Record<string, unknown>`
`schema`	`S`

typeFrontmatterSchemas = Record<string, FrontmatterSchema>Ordered source-relative globs. The first matching schema wins.

Ordered source-relative globs. The first matching schema wins.

Signature

export type FrontmatterSchemas = Record<string, FrontmatterSchema>

View source