NestedText

Please see NestedText for more information about this format.

In brief, it allows software to have data stored as text, similar to YAML and JSON, but without the ambiguity and quoting that's necessary with either one of those.

Here's a short example.

Katheryn McDaniel:
    position: president
    address:
        > 138 Almond Street
        > Topeka, Kansas 20697
    phone:
        cell: 1-210-555-5297
        home: 1-210-555-8470
            # Katheryn prefers that we always call her on her cell phone.
    email: [email protected]
    additional roles:
        - board member

This is a native JavaScript implementation of NestedText. There is also @rmw/nestedtext, which is much heavier (about 2 megs of WASM).

API

Start by loading the library. Choose your favorite method.

// CommonJS
const NestedText = require('nestedtext').NestedText;

// Modules
import NestedText from 'nestedtext';

// Alternately, load just the parts you need. This is the best for tree-shaking.
import { dump, load } from 'nestedtext';

<!-- Browser, HTML, loaded as window.NestedText -->
<script src="https://unpkg.com/nestedtext"></script>

<!-- Browser, loaded as a module -->
<script>
import NestedText from 'https://unpkg.com/inject-hooks?module';

// Or just load the parts you need
import { dump, load } from 'https://unpkg.com/inject-hooks?module';
</script>

NestedText.load(input: string)

Convert NestedText to native data structures.

NestedText.loadMin(input: string)

Convert Minimal NestedText to native data structures. This uses significantly less verbose error messages to help with minifying the bundle size when using loadMin.

NestedText.dump(input: string, options: DumpOptions)

Convert native data to NestedText.

The options can have the following properties:

• indent: What to use for indent. This must contain only spaces and must contain at least one space, otherwise it generates invalid NestedText. Defaults to four spaces to match the official tests.
• newline: The newline character to use. Defaults to \n.