Interface Pipeline

Compiles inputs from the project source into plain web resources

Hierarchy

Pipeline

Index

Properties

Methods

Properties

Readonly cache

cache: PipelineCache

Caches reusable data for the pipeline

Readonly htmlFormatter

htmlFormatter: HtmlFormatter

HTML formatter, if provided

Readonly pipelineIO

pipelineIO: PipelineIO

Frontend / Backend for the pipeline

Methods

compileFragment

compileFragment(resPath: string, fragmentContext?: FragmentContext): Promise<Fragment>

- Defined in lib/api/pipeline.ts:42
Compiles a fragment. This entry point should be used if the source HTML does not represent a complete page, or if further processing is to be done.

Parameters
- resPath: string
  
  Path to fragment source
- Optional fragmentContext: FragmentContext
  
  Data related to the specific usage context of this fragment
Returns Promise<Fragment>

Fragment instance

compilePage

compilePage(resPath: string): Promise<Page>

- Defined in lib/api/pipeline.ts:32
Compiles a page from start to finish. This entry point should be used with the source HTML is intended to be used as a full HTML page.

Parameters
- resPath: string
  
  Path to the page, relative to both source and destination.
Returns Promise<Page>

a Page containing the DOM and serialized / formatted HTML

reset

reset(): void

- Defined in lib/api/pipeline.ts:47
Resets the pipeline to its initial state.

Returns void

Generated using TypeDoc