Interface JSON5

interface JSON5 {
    parse<T>(text: string, reviver?: ((this: any, key: string, value: any) => any)): T;
    stringify(value: any, replacer?: ((this: any, key: string, value: any) => any), space?: string | number): string;
    stringify(value: any, replacer: (string | number)[], space?: string | number): string;
    stringify(value: any, options: StringifyOptions): string;
}

Methods

parse stringify

Methods

parse

  • parse<T>(text, reviver?): T

  • Parses a JSON5 string, constructing the JavaScript value or object described by the string.

    Type Parameters

    • T = any

      The type of the return value.

    Parameters

    • text: string

      The string to parse as JSON5.

    • Optionalreviver: ((this: any, key: string, value: any) => any)

      A function that prescribes how the value originally produced by parsing is transformed before being returned.

        • (this, key, value): any

        • Parameters

          • this: any
          • key: string
          • value: any

          Returns any

    Returns T

    The JavaScript value converted from the JSON5 string.

stringify

  • stringify(value, replacer?, space?): string

  • Converts a JavaScript value to a JSON5 string.

    Parameters

    • value: any

      The value to convert to a JSON5 string.

    • Optionalreplacer: ((this: any, key: string, value: any) => any)

      A function that alters the behavior of the stringification process. If this value is null or not provided, all properties of the object are included in the resulting JSON5 string.

        • (this, key, value): any

        • Parameters

          • this: any
          • key: string
          • value: any

          Returns any

    • Optionalspace: string | number

      A String or Number object that's used to insert white space into the output JSON5 string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space; this number is capped at 10 (if it is greater, the value is just 10). Values less than 1 indicate that no space should be used. If this is a String, the string (or the first 10 characters of the string, if it's longer than that) is used as white space. If this parameter is not provided (or is null), no white space is used. If white space is used, trailing commas will be used in objects and arrays.

    Returns string

    The JSON5 string converted from the JavaScript value.

  • stringify(value, replacer, space?): string

  • Converts a JavaScript value to a JSON5 string.

    Parameters

    • value: any

      The value to convert to a JSON5 string.

    • replacer: (string | number)[]

      An array of String and Number objects that serve as an allowlist for selecting/filtering the properties of the value object to be included in the JSON5 string. If this value is null or not provided, all properties of the object are included in the resulting JSON5 string.

    • Optionalspace: string | number

      A String or Number object that's used to insert white space into the output JSON5 string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space; this number is capped at 10 (if it is greater, the value is just 10). Values less than 1 indicate that no space should be used. If this is a String, the string (or the first 10 characters of the string, if it's longer than that) is used as white space. If this parameter is not provided (or is null), no white space is used. If white space is used, trailing commas will be used in objects and arrays.

    Returns string

    The JSON5 string converted from the JavaScript value.

  • stringify(value, options): string

  • Converts a JavaScript value to a JSON5 string.

    Parameters

    • value: any

      The value to convert to a JSON5 string.

    • options: StringifyOptions

      An object specifying options.

    Returns string

    The JSON5 string converted from the JavaScript value.

Settings

Member Visibility

On This Page

Methods