Type Alias ToStringOptions

Type declaration

• OptionalblockQuote?: boolean | "folded" | "literal"

  Use block quote styles for scalar values where applicable. Set to false to disable block quotes completely.

  Default: true

• OptionalcollectionStyle?: "any" | "block" | "flow"

  Enforce 'block' or 'flow' style on maps and sequences. Empty collections will always be stringified as {} or [].

  Default: 'any', allowing each node to set its style separately with its flow: boolean (default false) property.

• OptionalcommentString?: ((comment: string) => string)

  Comment stringifier. Output should be valid for the current schema.

  By default, empty comment lines are left empty, lines consisting of a single space are replaced by #, and all other lines are prefixed with a #.

  • • (comment): string

    • Parameters

      • comment: string

      Returns string

• OptionaldefaultKeyType?: Type | null

  The default type of string literal used to stringify implicit key values. Output may use other types if required to fully represent the value.

  If null, the value of defaultStringType is used.

  Default: null

• OptionaldefaultStringType?: Type

  The default type of string literal used to stringify values in general. Output may use other types if required to fully represent the value.

  Default: 'PLAIN'

• Optionaldirectives?: boolean | null

  Include directives in the output.

  • If true, at least the document-start marker --- is always included. This does not force the %YAML directive to be included. To do that, set doc.directives.yaml.explicit = true.
  • If false, no directives or marker is ever included. If using the %TAG directive, you are expected to include it manually in the stream before its use.
  • If null, directives and marker may be included if required.

  Default: null

• OptionaldoubleQuotedAsJSON?: boolean

  Restrict double-quoted strings to use JSON-compatible syntax.

  Default: false

• OptionaldoubleQuotedMinMultiLineLength?: number

  Minimum length for double-quoted strings to use multiple lines to represent the value. Ignored if doubleQuotedAsJSON is set.

  Default: 40

• OptionalfalseStr?: string

  String representation for false. With the core schema, use 'false', 'False', or 'FALSE'.

  Default: 'false'

• OptionalflowCollectionPadding?: boolean

  When true, a single space of padding will be added inside the delimiters of non-empty single-line flow collections.

  Default: true

• Optionalindent?: number

  The number of spaces to use when indenting code.

  Default: 2

• OptionalindentSeq?: boolean

  Whether block sequences should be indented.

  Default: true

• OptionallineWidth?: number

  Maximum line width (set to 0 to disable folding).

  This is a soft limit, as only double-quoted semantics allow for inserting a line break in the middle of a word, as well as being influenced by the minContentWidth option.

  Default: 80

• OptionalminContentWidth?: number

  Minimum line width for highly-indented content (set to 0 to disable).

  Default: 20

• OptionalnullStr?: string

  String representation for null. With the core schema, use 'null', 'Null', 'NULL', '~', or an empty string ''.

  Default: 'null'

• OptionalsimpleKeys?: boolean

  Require keys to be scalars and to use implicit rather than explicit notation.

  Default: false

• OptionalsingleQuote?: boolean | null

  Use 'single quote' rather than "double quote" where applicable. Set to false to disable single quotes completely.

  Default: null

• OptionaltrueStr?: string

  String representation for true. With the core schema, use 'true', 'True', or 'TRUE'.

  Default: 'true'

• OptionalverifyAliasOrder?: boolean

  The anchor used by an alias must be defined before the alias node. As it's possible for the document to be modified manually, the order may be verified during stringification.

  Default: 'true'