hokey-cokey

Hokey Cokey! Simple string template rendering and parameter value extracting

Hokey Cokey is a quick tool for extracting parameters from, and inserting parameters into, template strings:

• Extract:
  • Match a string (e.g. places/france/paris/) against a template (e.g. places/:country/{city})
  • Return found values (e.g. { country: "france", city: "paris" })
• Render:
  • With a template string (e.g. places/${country}/:city) and an object of values (e.g. { country: "france", city: "paris" })
  • Return the rendered output string after variables have been rendered in (e.g. places/france/paris/).

Things to know:

• Works with parameters in :express, {jsx}, {{handlebars}} or ${es6} format.
• Doesn't do anything complicated (like RegExp patterns, * glob patterns, or optional parameters).
• Parameter names must match the simple format [a-zA-Z][a-zA-Z0-9].
• When extracting values the template must have one character between each template parameter.
• Template destructuring is cached internally for performance.
• Well unit-tested and 100% covered.
• Useful for cases where RegExps are too fussy and you want something chunky and robust.

Installation

npm install hokey-cokey

Usage

extract(): Get values out of a template

const { extract } = require('hokey-cokey');
const values = extract("places/{country}/{city}", "places/france/paris");

// { country: "france", city: "paris" }
console.log(values); 

render(): Inject values into a template

const { render } = require("hokey-cokey");
const output = render("blogs/:category/:slug", { category: "cheeses", slug: "stilton" });

// "places/france/paris"
console.log(output);