Skip to content

ssg-output-write.ts#

View Markdown

Source

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

7 symbols 3 functions 3 interfaces 1 modules 4 parameters 13 members 3 returns

Reference#

fnresolveGitLastmod(filePath: string, root?: string): number | undefinedGit last-commit time for filePath in milliseconds. Same lookup buildSsg() uses…

Git last-commit time for filePath in milliseconds.

Same lookup buildSsg() uses for ssg.lastUpdated and sitemap <lastmod>. Returns undefined when root is missing, Git has no history, or NAPI is unavailable.

Signature

export function resolveGitLastmod(filePath: string, root?: string): number | undefined

View source

Parameters

  • filePath string
  • root string

    optional

Returns

number | undefined
modulessg-output-writeWriters for composable SSG outputs. Custom hosts call these without buildSsg().

Writers for composable SSG outputs. Custom hosts call these without buildSsg().

View source

fnwriteMarkdownCompanions(input: WriteMarkdownSourceFilesInput): Promise<{ files: string[]; errors: string[] }>Write Markdown companions for host-rendered pages. Reuses writeMarkdownSourceFi…

Write Markdown companions for host-rendered pages.

Reuses writeMarkdownSourceFiles from the copy-as-markdown pipeline.

Signature

export function writeMarkdownCompanions(input: WriteMarkdownSourceFilesInput): Promise<{ files: string[]; errors: string[] }>

View source

Parameters

Returns

Promise<{ files: string[]; errors: string[] }>
fnwriteResourceFiles(input: WriteResourceFilesInput): Promise<WriteResourceFilesResult>Fingerprint, rewrite, and emit page resources for host-rendered HTML. Uses the…

Fingerprint, rewrite, and emit page resources for host-rendered HTML.

Uses the same resources option object and emit path as buildSsg(). Throws PageResourceError when missing: "error" hits a fatal issue.

Signature

export async function writeResourceFiles(input: WriteResourceFilesInput): Promise<WriteResourceFilesResult>

View source

Parameters

Returns

Promise<WriteResourceFilesResult>
interfaceWriteResourceFilesInputInputs for writing fingerprinted page resources from host HTML.

Inputs for writing fingerprinted page resources from host HTML.

Signature

export interface WriteResourceFilesInput

View source

Members

Properties
NameTypeDescription
baseoptional string
cacheDiroptional string
optionsoptional ResolvedResourcesOptions | null
outDir string
pages readonly WriteResourceFilesPage[]
rootoptional string
srcDir string
interfaceWriteResourceFilesPageOne host-rendered page that may receive resource fingerprinting.

One host-rendered page that may receive resource fingerprinting.

Signature

export interface WriteResourceFilesPage

View source

Members

Properties
NameTypeDescription
html string
inputPath string
outputPath string
interfaceWriteResourceFilesResultRewritten host pages plus emitted resource paths.

Rewritten host pages plus emitted resource paths.

Signature

export interface WriteResourceFilesResult

View source

Members

Properties
NameTypeDescription
errors string[]
files string[]
pages WriteResourceFilesPage[]