@tson/parse v0.1.4

Terse Single Object Notation (TSON)

Terse Single Object Notation is a format for defining a single object with one or more properties, including support for nested properties.

Installation

yarn add @tson/parse

Parser

The @tson/parse package provides a parser for converting a TSON format string to a JavaScript object:

import parse from '@tson/parse'
// or const parse = require('@tson/parse')

parse('foo:bar')
//=> { foo: 'bar' }

Specification

To describe an object with TSON you can use one or more whitespace separated name:value pairs.

Scalar Values

By default a value is assumed to be a string.

The value will be converted to a number or a boolean if the conversion can be made implicitly.

You can use quotes to define string values, if you wish them to contain whitespace, number or boolean values, or special characters:

parse("foo:'true'")
//=> { foo: 'true' }

Omitting the property value is equivalent to boolean true:

parse('foo')
//=> { foo: true }

You can define multiple whitespace separated properties:

parse('foo:bar baz biz:5')
//=> { foo: 'bar', baz: true, biz: 5 }

Arrays

Arrays are defined with left and right brackets and comma separated values. The values will also be implicitly converted to number or boolean:

parse('foo:[5, bar, false]')
//=> { foo: [5, 'bar', false] }

Nested Objects

Nested objects are also supported:

parse('foo:{bar:5 baz:true}}')
//=> { foo: { bar: 5, baz: true } }