Variable jsoncConst

Type Declaration

• array: function

  • array(lines: readonly JsoncLine[]): JsoncDocument

    Build an array from values, comments, blank lines, and optional groups.

    Parameters

    • lines: readonly JsoncLine[]

    Returns JsoncDocument

• blank: function

  • blank(): JsoncCommand

    Insert an intentional empty line.

    Returns JsoncCommand

• comment: function

  • comment(text: string): JsoncCommand

    Add a // comment. Each line of multiline text receives its own comment prefix.

    Parameters

    • text: string

    Returns JsoncCommand

• concat: function

  • concat(...lines: readonly JsoncLine[]): JsoncDocument

    Join a document's comments and single root value, separating commands by newlines.

    Parameters

    • ...lines: readonly JsoncLine[]

    Returns JsoncDocument

    Example

    jsonc.concat(jsonc.comment("Editor settings"), jsonc.object([jsonc.property("theme", "dark")]))
    Copy

• object: function

  • object(lines: readonly JsoncLine[]): JsoncDocument

    Build an object from properties, comments, blank lines, and optional groups.

    Parameters

    • lines: readonly JsoncLine[]

    Returns JsoncDocument

• property: function

  • property(name: string, value: ConfigValue | JsoncDocument): JsoncCommand

    Add an object property. Values may be ordinary JSON data or a nested JSONC document.

    Parameters

    • name: string
    • value: ConfigValue | JsoncDocument

    Returns JsoncCommand

• value: function

  • value(value: ConfigValue | JsoncDocument): JsoncCommand

    Add a JSON value, for example an array element or a primitive document root.

    Parameters

    • value: ConfigValue | JsoncDocument

    Returns JsoncCommand