Package Exports
- inks
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 (inks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
inks
Interpolate values from a shared context into a string template (or another object).
Substitutes sections of a string marked with `` by evaluating contents. As a convenience, the values can be referenced from a context object.
Used by seneca-msg-test to support back references to earlier test results.
Quick Example
const Inks = require('inks')
var out = Inks('`foo:bar`', {foo:{bar:'zed'}})
// out === 'zed'
out = Inks({deep:'`foo:bar`'}, {foo:{bar:'zed'}})
// out === {deep:'zed'}
out = Inks({deep:'`$.foo`'}, {foo:{bar:'zed'}})
// out === {deep:{bar:'zed'}}
Another example, where $ references the context object.
const context = { red: { foo: 1, bar: 'zed'}, green: { fizz: { buzz: 'FRED' }} }
const template = 'Lorem `red:foo` ipsum `$.red.foo + $.red.bar.length` dolor `green:fizz.buzz` sit \\` amet.'
const result = Inks(template, context)
// prints:
// Lorem 1 ipsum 4 dolor FRED sit ` amet.
Notes
- Value reference syntax:
key:dot-path. - General form:
<js-expression>where$ === context. - Single values are not converted to a string and retain their type:
red:foo->1not'1'. - Anything that is not a number or string is converted to a string (if embedded) using
JSON.stringify.
Questions?
License
Copyright (c) 2018, Richard Rodger and other contributors. Licensed under MIT.