placeholders

Replace placeholder values in a file path.

Usage no npm install needed!

<script type="module">
  import placeholders from 'https://cdn.skypack.dev/placeholders';
</script>

README

placeholders NPM version NPM monthly downloads NPM total downloads Linux Build Status Windows Build Status

Replace placeholder values in a file path.

Install

Install with npm:

$ npm install --save placeholders

Install with yarn:

$ yarn add placeholders

Install

Install with npm:

$ npm install --save placeholders

Usage

var placeholders = require('placeholders')(options);

placeholders('/site/blog/:path', {path: 'foo-bar.md'});
//=> '/site/blog/foo-bar.md'

Options

Options may be passed to the main function.

var placeholders = require('placeholders')(options);

options.regex

Pass a custom regex to use for replacements.

Type: {RegExp}

Default: the default regex matches es6 delimiters and lodash template syntax.

Example

Match printf-like strings:

var placeholders = require('placeholders')({
  regex: /%([^%]+)%/
});

options.data

Pass a data object on the main function to use for resolving values.

Type: {Object}

Default: undefined

Example

var placeholders = require('placeholders')({
  data: {foo: 'one', bar: 'two'}
});

placeholders(':foo/:bar/:baz', {baz: 'three'})
//=> 'one/two/three'

returns a function when no data is passed

This allows you to reuse the same pattern with different data, like a compiled template.

var placeholders = require('placeholders')({
  regex: /%([^%]+)%/
});

var fn = placeholders('foo/%bar%/%baz%');
fn({bar: 'one', baz: 'two'})
//=> 'foo/one/two'
fn({bar: 'a', baz: 'b'})
//=> 'foo/a/b'

About

Related projects

  • assign-deep: Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target… more | homepage
  • expand: Recursively resolve templates in an object, string or array. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits Contributor
13 jonschlinkert
8 doowb

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on June 17, 2017.