@draftbit/variable-json
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

VJson: JSON with variables

This defines a superset of JSON, with the addition of "variables" which appear between curly braces (e.g. {{someVariable}}). The format of the variables can be customized by the user, although by default it will parse an alphanuxmeric identifier which can start with a letter or underscore and subsequently contain any letter, digit or _. Although by default variables are strings, the vjson type is polymorphic and the structure can be mapped over to support more complex information.

{
  "id": {{id}},
  "color": {{color}},
  "allSizes": ["small", "medium", "large"],
  "size": {{size}},
}

This library provides tools for:

  • Parsing the above syntax, including custom variable formats
  • Finding the set of variables in a given tree
  • Replacing all of the variables in a tree with JSON, producing a JSON object

Example

let vJson: VJson.t(string) = VJson.parseDefault("{
  \"id\": {{id}},
  \"color\": {{color}},
  \"allSizes\": [\"small\", \"medium\", \"large\"],
  \"size\": {{size}},
}")->Belt.Result.getExn;

// Prints "Set { 'id', 'color', 'size' }"
Js.log(vJson->VJson.findVariables);

// Customizing the variable format to integers
let vJsonWithInts: VJson.t(int) = VJson.(
    "{{123}}"
    |> VJson.parseWithRegex([%re {|/\d+/|}])
    |> Belt.Result.getExn
  )
  ->VJson.map(int_of_string)

Build

yarn re:build

Watch

yarn re:watch

Readme

Keywords

Package Sidebar

Install

npm i @draftbit/variable-json

Weekly Downloads

1

Version

1.0.2

License

MIT

Unpacked Size

425 kB

Total Files

8

Last publish

Collaborators

  • sieuhuflit
  • s0laster
  • youssefhenna
  • bluerssen
  • adnelson