Unit 'Json2Yaml' Package
[Overview][Classes][Index] [#fcl]

TJSONToYaml.AddHeader

Controls whether to add YAML document header

Declaration

Source position: json2yaml.pp line 55

public property TJSONToYaml.AddHeader : Boolean
  read FAddHeader
  write FAddHeader;

Description

The AddHeader property determines whether a YAML document separator (---) is written at the beginning of the converted output. When set to True, the YAML document header is added before the actual content. When False, only the converted JSON content is written to the output stream.

The YAML document separator is part of the YAML specification and indicates the start of a YAML document, which can be useful when multiple YAML documents are concatenated or when strict YAML compliance is required.

See also

Convert

  

Convert JSON data to YAML format


Documentation generated on: Mar 09 2026