Skip to content

YamlWriterOptions

Definition

Namespace: Corvus.Yaml
Assembly: Corvus.Text.Json.dll

Options for configuring the YAML writer.

public readonly struct YamlWriterOptions

Constructors

Constructor Description
YamlWriterOptions() Initializes a new instance of the YamlWriterOptions struct with default values.

Properties

Property Type Description
Format YamlWriterFormat Gets the output dialect produced by the writer. Defaults to Yaml.
IndentSize int Gets the number of spaces to use for each indentation level. Defaults to 2.
SkipValidation bool Gets a value indicating whether to skip structural validation. When false (the default), the writer validates that write operations produce structurally valid YAML.

Fields

Field Type Description
Default static YamlWriterOptions Gets the default options: canonical YAML, 2-space indentation, structural validation enabled.
Kyaml static YamlWriterOptions Gets options that produce KYAML output (a strict subset of YAML 1.2; Kubernetes KEP-5295) with 2-space indentation and structural validation enabled.

Applies To

Product Versions
.NET 9, 10
.NET Standard 2.0, 2.1

Collaborate with us on GitHub

The source for this content can be found on GitHub, where you can also create and review issues and pull requests.

Open an issue