Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/node-core-library > JsonSyntax

JsonSyntax enum

Specifies the variant of JSON syntax to be used.

Signature:

export declare enum JsonSyntax 

Enumeration Members

MemberValueDescription
Json5"json5"JSON5 is a project that proposes a JSON-like format supplemented with ECMAScript 5.1 notations for objects, numbers, comments, and more.
JsonWithComments"jsonWithComments"JsonSyntax.JsonWithComments is the recommended format for human-authored config files. It is a minimal extension to JsonSyntax.Strict adding support for code comments using // and /*.
Strict"strict"Specifies the exact RFC 8259 format as implemented by the JSON.parse() system API. This format was designed for machine generated inputs such as an HTTP payload. It is not a recommend choice for human-authored files, because it does not support code comments.