teddit-reddit-frontend-alte.../node_modules/pug-filters
teddit fdfcd554f8 initial commit 2020-11-17 21:44:32 +01:00
..
lib initial commit 2020-11-17 21:44:32 +01:00
CHANGELOG.md initial commit 2020-11-17 21:44:32 +01:00
LICENSE initial commit 2020-11-17 21:44:32 +01:00
README.md initial commit 2020-11-17 21:44:32 +01:00
index.js initial commit 2020-11-17 21:44:32 +01:00
package.json initial commit 2020-11-17 21:44:32 +01:00

README.md

pug-filters

Code for processing filters in pug templates

Build Status Dependencies Status DevDependencies Status NPM version

Installation

npm install pug-filters

Usage

var filters = require('pug-filters');

filters.handleFilters(ast, filters)

Renders all Filter nodes in a Pug AST (ast), using user-specified filters (filters) or a JSTransformer.

filters.runFilter(name, str[, options[, currentDirectory]])

Invokes filter through jstransformer.

This is internally used in filters.handleFilters, and is a lower-level interface exclusively for invoking JSTransformer-based filters.

name represents the name of the JSTransformer.

str represents the string to render.

currentDirectory is used when attempting to require the transformer module.

options may contain the following properties:

  • minify (boolean): whether or not to attempt minifying the result from the transformer. If minification fails, the original result is returned.

License

MIT