System.Text.Json.JsonSerializerOptions

JsonSerializerOptions

public sealed class JsonSerializerOptions

Provides options to be used with JsonSerializer.

public bool AllowTrailingCommas { get; set; }

Defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being deserialized.

public IList<JsonConverter> Converters { get; }

The list of custom converters.

public int DefaultBufferSize { get; set; }

The default buffer size in bytes used when creating temporary buffers.

public JsonIgnoreCondition DefaultIgnoreCondition { get; set; }

Specifies a condition to determine when properties with default values are ignored during serialization or deserialization. The default value is Never.

public JsonNamingPolicy DictionaryKeyPolicy { get; set; }

Specifies the policy used to convert a IDictionary key's name to another format, such as camel-casing.

public JavaScriptEncoder Encoder { get; set; }

The encoder to use when escaping strings, or null to use the default encoder.

public bool IgnoreNullValues { get; set; }

Determines whether null values are ignored during serialization and deserialization. The default value is false.

public bool IgnoreReadOnlyFields { get; set; }

Determines whether read-only fields are ignored during serialization. A field is read-only if it is marked with the readonly keyword. The default value is false.

public bool IgnoreReadOnlyProperties { get; set; }

Determines whether read-only properties are ignored during serialization. A property is read-only if it contains a public getter but not a public setter. The default value is false.

public bool IncludeFields { get; set; }

Determines whether fields are handled on serialization and deserialization. The default value is false.

public int MaxDepth { get; set; }

Gets or sets the maximum depth allowed when serializing or deserializing JSON, with the default (i.e. 0) indicating a max depth of 64.

public JsonNumberHandling NumberHandling { get; set; }

Specifies how number types should be handled when serializing or deserializing.

public bool PropertyNameCaseInsensitive { get; set; }

Determines whether a property's name uses a case-insensitive comparison during deserialization. The default value is false.

public JsonNamingPolicy PropertyNamingPolicy { get; set; }

Specifies the policy used to convert a property's name on an object to another format, such as camel-casing. The resulting property name is expected to match the JSON payload during deserialization, and will be used when writing the property name during serialization.

public JsonCommentHandling ReadCommentHandling { get; set; }

Defines how the comments are handled during deserialization.

public ReferenceHandler ReferenceHandler { get; set; }

Configures how object references are handled when reading and writing JSON.

public JsonUnknownTypeHandling UnknownTypeHandling { get; set; }

Defines how deserializing a type declared as an Object is handled during deserialization.

public bool WriteIndented { get; set; }

Defines whether JSON should pretty print which includes: indenting nested JSON tokens, adding new lines, and adding white space between property names and values. By default, the JSON is serialized without any extra white space.

public JsonSerializerOptions()

Constructs a new JsonSerializerOptions instance.

public JsonSerializerOptions(JsonSerializerOptions options)

Copies the options from a JsonSerializerOptions instance to a new instance.

public JsonSerializerOptions(JsonSerializerDefaults defaults)

Constructs a new JsonSerializerOptions instance with a predefined set of options determined by the specified JsonSerializerDefaults.

public void AddContext<TContext>() where TContext : JsonSerializerContext

Binds current JsonSerializerOptions instance with a new instance of the specified JsonSerializerContext type.

public JsonConverter GetConverter(Type typeToConvert)

Returns the converter for the specified type.