Module lib

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

EvalFunction

EvalFunction<T>: ($: ScopeData, $$: EvalContext, require: MooltipageRequire) => T | Promise<T>

A function-based expression

Type parameters

T

Type declaration

- ($: ScopeData, $$: EvalContext, require: MooltipageRequire): T | Promise<T>
- Parameters
  - $: ScopeData
  - $$: EvalContext
  - require: MooltipageRequire
  Returns T | Promise<T>

MDataNodeType

MDataNodeType: JSON | TEXT

Supported MIME types of data contents

MooltipageRequire

MooltipageRequire: (path: string) => unknown

Loads a module using require() relative from the Mooltipage code root

Type declaration

- (path: string): unknown
- Parameters
  - path: string
  Returns unknown

PageCompiledCallback

PageCompiledCallback: (page: Page) => Promise<void>

Called whenever a page is compiled.

param: Compiled Page object

Type declaration

- (page: Page): Promise<void>
- Parameters
  - page: Page
  Returns Promise<void>

ScopeData

ScopeData: Record<ScopeKey, unknown>

Local scope data

ScopeKey

ScopeKey: string | number

Type of key for scope data

Functions

getResourceTypeExtension

getResourceTypeExtension(resourceType: MimeType): string

- Defined in lib/api/pipeline.ts:217
Gets the filename extension to use for a specified resource type. Defaults to "dat" for unknown resource types.

Parameters
- resourceType: MimeType
  
  Resource type to get extension for
Returns string

filename extension, without the dot.

parseAnchorNodeResolve

parseAnchorNodeResolve(value: string | undefined): AnchorNodeResolve

- Defined in lib/dom/node.ts:1865
Parses a string value as an AnchorNodeResolve. An undefined or null value will be default to AnchorNodeResolve.NONE.

throws

If {@link value} is not a valid value for AnchorNodeResolve.

Parameters
- value: string | undefined
  
  String value to pass
Returns AnchorNodeResolve

Parsed value of {@link value} or default.

Generated using TypeDoc