Package Exports

delimiters

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (delimiters) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

delimiters

Set and get custom template delimiters.

Install

Install with npm:

npm i delimiters --save-dev

Usage

var delimiters = require('delimiters');

API

Delimiters

Create a new instance of Delimiters, optionally passing default options to use.

Example:

var Delimiters = require('delimiters');
var delimiters = new Delimiters();

options {Object}: Options to use.

.option

Set or get an option.

delimiters.option('a', true)
delimiters.option('a')
// => true

key {String}
value {*}
return {*}

.addDelims

Store delimiters by name with the given options for later use.

Example:

delimiters.addDelims('curly', ['']);
delimiters.addDelims('angle', ['<%', '%>']);
delimiters.addDelims('es6', ['${', '}'], {
  // override the generated regex
  interpolate: /\$\{([^\\}]*(?:\\.[^\\}]*)*)\}/g
});

name {String}: The name to use for the stored delimiters.
delims {Array}: Array of delimiter strings. See delims for details.
opts {Object}: Options to pass to delims. You can also use the options to override any of the generated delimiters.

.useDelims

Specify by name the delimiters to make active.

delimiters.useDelims('curly');
delimiters.useDelims('angle');

name {String}

Author

Jon Schlinkert

License

This file was generated by verb-cli on August 09, 2014.