JsonSerializerOptions.AllowOutOfOrderMetadataProperties Property

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-rc.2.24473.5

Allows JSON metadata properties to be specified after regular properties in a deserialized JSON object.

public:
 property bool AllowOutOfOrderMetadataProperties { bool get(); void set(bool value); };

public bool AllowOutOfOrderMetadataProperties { get; set; }

member this.AllowOutOfOrderMetadataProperties : bool with get, set

Public Property AllowOutOfOrderMetadataProperties As Boolean

Property Value

Boolean

Exceptions

InvalidOperationException

Thrown if this property is set after serialization or deserialization has occurred.

Remarks

When set to true, removes the requirement that JSON metadata properties

such as $id and $type should be specified at the very start of the deserialized JSON object.

It should be noted that enabling this setting can result in over-buffering

when deserializing large JSON payloads in the context of streaming deserialization.