paraphrase 

🧩 Create flavoured string template interpolation

  

``
npm i paraphrase
`

Creates new paraphrase method instance

`js
import { paraphrase } from "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

$3

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

`js
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

`js
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

`js
const phrase = paraphrase(/\${([^{}]*)}/gm, { clean: true });

phrase("Hello, ${firstname} ${lastname}", { firstname: "Martin" }); // Hello, Martin
`

Examples

$3

`js
phrase("Hello, ${name}", { name: "Martin" }); // Hello, Martin
`

$3

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

$3

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

$3

`js
phrase("Hello, ${0} ${1}", "Martin", "Prince"); // Hello, Martin Prince
`

Premade

$3

`js
import { dollar as phrase } from "paraphrase";

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

$3

`js
import { double as phrase } from "paraphrase";

phrase("Hello, {{name}}", { name: "Martin" }); // Hello, Martin
`

$3

`js
import { single as phrase } from "paraphrase";

phrase("Hello, {name}", { name: "Martin" }); // Hello, Martin
`

$3

`js
import { percent as phrase } from "paraphrase";

phrase("Hello, %{name}", { name: "Martin" }); // Hello, Martin
`

$3

`js
import { hash as phrase } from "paraphrase";

phrase("Hello, #{name}", { name: "Martin" }); // Hello, Martin
`

$3

`js
import { loose as phrase } from 'paraphrase';

phrase('Hello, #{name.first} {name.last}', {name: { first: 'Martin', last: 'Prince' }); // Hello, Martin Prince
`

patterns

A paraphrase instance exposes view to its patterns array (immutable)

`js
import { hash as phrase } from "paraphrase";

phrase.patterns; // [ /#{([^{}]*)}/gm ]
``