splat-es

SplatES: a string templating utility

A small string templating utility. Use it to replace tags (tokens, e.g. Hello {myToken}) within strings using one or more Objects for replacements (e.g. {myToken: "world!"}).

The utiltity by default exports a function to replace one or more tokens ("Some string {token1}, {token2}") within a string.

The tokens are replaced using one or more objects containing the tokens to replace as keys and the values to replace it/them with ( [imported interpolator]("Some string {token1}, {token2}", {token1: "one"}, token2: "two"}))).

The module exports

• the factory itself interpolateFactory),
• the interpolate function (default),
• the interpolateClear function (which clears empty placeholders) and
• a function to extend String.prototype with symbolic methods.

Repository location

The repository is available at two locations: Github (US) and Codeberg (Europe).

US politics may result in precarious future US/Github policies, which may result in the Github repository ceasing to exist in the future.

The Codeberg repository is therefore authorative.

Check the DEMO @Codeberg, or the DEMO @Github.

Loading/importing

Browser

<!-- the browser script is located at /Bundle/index.script.min.js -->
<script src="[browser script location]"></script>
<script>
  const {default: splat /* [, interpolateClear, interpolateFactory, addSymbolicStringExtensions] */} = SplatES;
  splat(hi, {wrld: "world"}); // "hi world"
</script>

ESM (module)

// the module is located at /index.js, 
// or bundled at /Bundle/index.min.js
import {default as splat /* [, interpolateClear, interpolateFactory, addSymbolicStringExtensions] */}
  from "[path/to]/Interpolate.node.js]";
splat(hi, {wrld: "world"}); // "hi world"