Class: BajoTemplate

new BajoTemplate()

BajoTemplate class definition.

Source: index.js, line 18

Members

config

Properties

Name Type Description

config

object

Configuration object

Properties

Name Type Attributes Default Description

layout

object

{}

Layout configuration

Properties

Name	Type	Attributes	Default	Description
`fallback`	boolean	<optional>	true	Whether to fallback to default layout if not found

loopDetectorDur

Number | string

'1m'

Duration for loop detection

log

object

{}

Logging configuration

Properties

Name	Type	Attributes	Default	Description
`resolver`	boolean	<optional>	false	Whether to log resolver actions

cache

object

{}

Cache configuration

Properties

Name	Type	Attributes	Default	Description
`ttlDur`	Number \| string	<optional>	'1s'	Time-to-live duration for cache

Source: index.js, line 39

loopDetector

Properties

Name	Type	Description
`loopDetector`	object	Loop detection object

Source: index.js, line 54

Methods

buildCompileImports(locals, req) → {TImportsResult}

Build compile imports. Used to provide utility functions to templates.

Parameters:

Name	Type	Description
`locals`	object	Locals object
`req`	object	Request object

Source: index.js, line 65

Returns:

Imports object

Type:: TImportsResult

(async) compile(content, locals, options) → {Promise.<function()>}

Compile a template with the given content and locals.

Parameters:

Name Type Description

content

string

Template content

locals

object

Locals object

options

object

Options object

Properties

Name	Type	Description
`ttl`	number	Time to live for cache
`req`	object	Request object

Source: index.js, line 419

Returns:

Compiled template function

Type:: Promise.<function()>

getExcerpt(content, maxWords, trailChars) → {string}

Get an excerpt from the content.

Parameters:

Name	Type	Description
`content`	string	Content string
`maxWords`	number	Maximum number of words
`trailChars`	string	Trailing characters

Source: index.js, line 606
See: Problem Solving: How to Create an Excerpt

Returns:

Excerpt

Type:: string

getResource(name) → {object}

Get a resource by name.

Parameters:

Name	Type	Description
`name`	string	Resource name

Source: index.js, line 379

Returns:

Resource object

Type:: object

getTruncated(content, maxChars, trailChars) → {string}

Get a truncated version of the content.

Parameters:

Name	Type	Description
`content`	string	Content string
`maxChars`	number	Maximum number of characters
`trailChars`	string	Trailing characters

Source: index.js, line 622

Returns:

Truncated content

Type:: string

(async) parseFrontMatter(input, lang) → {Promise.<object>}

Parse front matter from the input string.

Parameters:

Name	Type	Description
`input`	string	Input string
`lang`	string	Language

Source: index.js, line 398

Returns:

Parsed front matter

Type:: Promise.<object>

(async) render(tpl, locals, opts) → {Promise.<string>}

Render a template with the given locals and options.

Parameters:

Name	Type	Description
`tpl`	string	Template name
`locals`	object	Locals object
`opts`	object	Options object

Source: index.js, line 463

Returns:

Rendered template

Type:: Promise.<string>

(async) renderString(content, locals, opts) → {Promise.<string>}

Render a string with the given locals and options.

Parameters:

Name	Type	Description
`content`	string	Content string
`locals`	object	Locals object
`opts`	object	Options object

Source: index.js, line 447

Returns:

Rendered content

Type:: Promise.<string>

resolveLayout(item, opts) → {object}

Resolve a layout by name.

Parameters:

Name	Type	Description
`item`	string	Layout name
`opts`	object	Options object

Source: index.js, line 532

Returns:

Resolved layout

Type:: object

resolvePartial(item, opts) → {object}

Resolve a partial by name.

Parameters:

Name	Type	Description
`item`	string	Partial name
`opts`	object	Options object

Source: index.js, line 550

Returns:

Resolved partial

Type:: object

resolveResource(type, item, opts, fallbackHandler) → {object}

Resolve a resource by type and name.

Parameters:

Name	Type	Description
`type`	string	Resource type
`item`	string	Resource name
`opts`	object	Options object
`fallbackHandler`	function	Fallback handler function

Source: index.js, line 494

Returns:

Resolved resource

Type:: object

resolveTemplate(item, opts) → {object}

Resolve a template by name.

Parameters:

Name	Type	Description
`item`	string	Template name
`opts`	object	Options object

Source: index.js, line 562

Returns:

Resolved template

Type:: object

splitContent(input, readFile) → {object}

Split content into front matter and body.

Parameters:

Name	Type	Description
`input`	string	Input string or file path
`readFile`	boolean	Whether to read the file

Source: index.js, line 574

Returns:

Object containing frontMatter and content

Type:: object

new BajoTemplate()

Constructor

Source: index.js, line 27

Members

config

Properties

Name Type Description

config

object

Configuration object

Properties

Name Type Attributes Default Description

layout

object

{}

Layout configuration

Properties

Name	Type	Attributes	Default	Description
`fallback`	boolean	<optional>	true	Whether to fallback to default layout if not found

loopDetectorDur

Number | string

'1m'

Duration for loop detection

log

object

{}

Logging configuration

Properties

Name	Type	Attributes	Default	Description
`resolver`	boolean	<optional>	false	Whether to log resolver actions

cache

object

{}

Cache configuration

Properties

Name	Type	Attributes	Default	Description
`ttlDur`	Number \| string	<optional>	'1s'	Time-to-live duration for cache

Source: index.js, line 39

loopDetector

Properties

Name	Type	Description
`loopDetector`	object	Loop detection object

Source: index.js, line 54

Methods

buildCompileImports(locals, req) → {TImportsResult}

Build compile imports. Used to provide utility functions to templates.

Parameters:

Name	Type	Description
`locals`	object	Locals object
`req`	object	Request object

Source: index.js, line 65

Returns:

Imports object

Type:: TImportsResult

(async) compile(content, locals, options) → {Promise.<function()>}

Compile a template with the given content and locals.

Parameters:

Name Type Description

content

string

Template content

locals

object

Locals object

options

object

Options object

Properties

Name	Type	Description
`ttl`	number	Time to live for cache
`req`	object	Request object

Source: index.js, line 419

Returns:

Compiled template function

Type:: Promise.<function()>

getExcerpt(content, maxWords, trailChars) → {string}

Get an excerpt from the content.

Parameters:

Name	Type	Description
`content`	string	Content string
`maxWords`	number	Maximum number of words
`trailChars`	string	Trailing characters

Source: index.js, line 606
See: Problem Solving: How to Create an Excerpt

Returns:

Excerpt

Type:: string

getResource(name) → {object}

Get a resource by name.

Parameters:

Name	Type	Description
`name`	string	Resource name

Source: index.js, line 379

Returns:

Resource object

Type:: object

getTruncated(content, maxChars, trailChars) → {string}

Get a truncated version of the content.

Parameters:

Name	Type	Description
`content`	string	Content string
`maxChars`	number	Maximum number of characters
`trailChars`	string	Trailing characters

Source: index.js, line 622

Returns:

Truncated content

Type:: string

(async) parseFrontMatter(input, lang) → {Promise.<object>}

Parse front matter from the input string.

Parameters:

Name	Type	Description
`input`	string	Input string
`lang`	string	Language

Source: index.js, line 398

Returns:

Parsed front matter

Type:: Promise.<object>

(async) render(tpl, locals, opts) → {Promise.<string>}

Render a template with the given locals and options.

Parameters:

Name	Type	Description
`tpl`	string	Template name
`locals`	object	Locals object
`opts`	object	Options object

Source: index.js, line 463

Returns:

Rendered template

Type:: Promise.<string>

(async) renderString(content, locals, opts) → {Promise.<string>}

Render a string with the given locals and options.

Parameters:

Name	Type	Description
`content`	string	Content string
`locals`	object	Locals object
`opts`	object	Options object

Source: index.js, line 447

Returns:

Rendered content

Type:: Promise.<string>

resolveLayout(item, opts) → {object}

Resolve a layout by name.

Parameters:

Name	Type	Description
`item`	string	Layout name
`opts`	object	Options object

Source: index.js, line 532

Returns:

Resolved layout

Type:: object

resolvePartial(item, opts) → {object}

Resolve a partial by name.

Parameters:

Name	Type	Description
`item`	string	Partial name
`opts`	object	Options object

Source: index.js, line 550

Returns:

Resolved partial

Type:: object

resolveResource(type, item, opts, fallbackHandler) → {object}

Resolve a resource by type and name.

Parameters:

Name	Type	Description
`type`	string	Resource type
`item`	string	Resource name
`opts`	object	Options object
`fallbackHandler`	function	Fallback handler function

Source: index.js, line 494

Returns:

Resolved resource

Type:: object

resolveTemplate(item, opts) → {object}

Resolve a template by name.

Parameters:

Name	Type	Description
`item`	string	Template name
`opts`	object	Options object

Source: index.js, line 562

Returns:

Resolved template

Type:: object

splitContent(input, readFile) → {object}

Split content into front matter and body.

Parameters:

Name	Type	Description
`input`	string	Input string or file path
`readFile`	boolean	Whether to read the file

Source: index.js, line 574

Returns:

Object containing frontMatter and content

Type:: object