@std/toml

Overview Jump to heading#

parse and stringify for handling TOML encoded data.

Be sure to read the supported types as not every spec is supported at the moment and the handling in TypeScript side is a bit different.

Supported types and handling

• Keys
• String
• Multiline String
• Literal String
• Integer
• Float
• Boolean
• Offset Date-time
• Local Date-time
• Local Date
• Local Time
• Table
• Inline Table
• Array of Tables

Supported with warnings see Warning.

Warning

String

Due to the spec, there is no flag to detect regex properly in a TOML declaration. So the regex is stored as string.

Integer

For Binary / Octal / Hexadecimal numbers, they are stored as string to be not interpreted as Decimal.

Local Time

Because local time does not exist in JavaScript, the local time is stored as a string.

Array of Tables

At the moment only simple declarations like below are supported:

[[bin]]
name = "deno"
path = "cli/main.rs"

[[bin]]
name = "deno_core"
path = "src/foo.rs"

[[nib]]
name = "node"
path = "not_found"

will output:

{
  "bin": [
    { "name": "deno", "path": "cli/main.rs" },
    { "name": "deno_core", "path": "src/foo.rs" }
  ],
  "nib": [{ "name": "node", "path": "not_found" }]
}

import { parse, stringify } from "@std/toml";
import { assertEquals } from "@std/assert";

const obj = {
  bin: [
    { name: "deno", path: "cli/main.rs" },
    { name: "deno_core", path: "src/foo.rs" },
  ],
  nib: [{ name: "node", path: "not_found" }],
};

const tomlString = stringify(obj);
assertEquals(tomlString, `
[[bin]]
name = "deno"
path = "cli/main.rs"

[[bin]]
name = "deno_core"
path = "src/foo.rs"

[[nib]]
name = "node"
path = "not_found"
`);

const tomlObject = parse(tomlString);
assertEquals(tomlObject, obj);

Add to your project Jump to heading#

deno add jsr:@std/toml

See all symbols in @std/toml on

What is TOML? Jump to heading#

TOML (Tom's Obvious, Minimal Language) is a configuration file format that is easy to read due to its simple syntax. It supports various data types like strings, numbers, booleans, dates, arrays, and tables, making it versatile for configurations.

Why use @std/toml? Jump to heading#

This module provides a simple and efficient way to parse and stringify TOML data in JavaScript. Use it to read configuration files or generate TOML content programmatically.

Tips Jump to heading#

• Mind the supported types: some TOML constructs are represented as strings in JS.
• Use arrays-of-tables for repeated sections; keep structures simple for clarity.