Need private packages and team management tools?Check out npm Teams ¬Ľ

paraphrase

1.8.0¬†‚Äʬ†Public¬†‚Äʬ†Published

paraphrase

ūüß© Create flavoured string template interpolation

npm i paraphrase

Creates new paraphrase method instance

const paraphrase = require('paraphrase');
const phrase = paraphrase(/\${([^{}]*)}/gm); // Create a new phrase function using a RegExp match
 
phrase('Hello, ${name}', {name: 'Martin'}); // Hello, Martin

Acceptable replacements (values) are strings and numbers

Arguments and Options

One or more RegExp replacers, an optional options object at the end

option meaning type default
recursive Should continue to resolve result string until replacements have been exhausted Boolean true
resolve Should resolve dot notations within the template Boolean true
clean Should remove unmatched template instances Boolean false
Multiple replacers
const phrase = paraphrase(/\${([^{}]*)}/gm, /\{{([^{}]*)}}/gm);
 
phrase('Hello, ${firstname} {{lastname}}', {firstname: 'Martin', 'lastname': 'Prince'}); // Hello, Martin Prince
Dot notation resolve

Treat dots as part of the key instead of notation marks

const phrase = paraphrase(/\${([^{}]*)}/gm, {resolve: false});
 
phrase('Hello, ${name} ${last.name}', {name: 'Martin', 'last.name': 'Prince'}); // Hello, Martin Prince
Unmatched cleanup

Remove unmatched template instances from the result string

const phrase = paraphrase(/\${([^{}]*)}/gm, {clean: true});
 
phrase('Hello, ${firstname} ${lastname}', {firstname: 'Martin'}); // Hello, Martin

Examples

Objects

phrase('Hello, ${name}', {name: 'Martin'}); // Hello, Martin

Objects with dot notation

const user = {
    name: {first: 'Martin', last: 'Prince'}
};
phrase('Hello, ${name.first} ${name.last}', user); // Hello, Martin Prince

Arrays

phrase('Hello, ${0} ${1}', ['Martin', 'Prince']); // Hello, Martin Prince

Spread arguments

phrase('Hello, ${0} ${1}', 'Martin', 'Prince'); // Hello, Martin Prince

Premade

dollar ${...}

const phrase = require('paraphrase/dollar');
 
phrase('Hello, ${name}', {name: 'Martin'}); // Hello, Martin

double {{...}}

const phrase = require('paraphrase/double');
 
phrase('Hello, {{name}}', {name: 'Martin'}); // Hello, Martin

single {...}

const phrase = require('paraphrase/single');
 
phrase('Hello, {name}', {name: 'Martin'}); // Hello, Martin

percent %{...} (i18n style)

const phrase = require('paraphrase/percent');
 
phrase('Hello, %{name}', {name: 'Martin'}); // Hello, Martin

hash #{...} (ruby style)

const phrase = require('paraphrase/hash');
 
phrase('Hello, #{name}', {name: 'Martin'}); // Hello, Martin

patterns

A paraphrase instance exposes access to it's patterns array

const phrase = require('paraphrase/hash');
 
phrase.patterns // [ /#{([^{}]*)}/gm ]

Install

npm i paraphrase

DownloadsWeekly Downloads

1,957

Version

1.8.0

License

MIT

Unpacked Size

24.6 kB

Total Files

10

Last publish

Collaborators

  • avatar