Class JsonStreamOptions

Namespace

NextORM.Core

Assembly

nextorm.core.dll

Shape options for the JSON streaming terminals (QueryCommand.WriteJson / EntityBuilder.WriteJsonAsync). The options are validated when the shape plan is built.

public sealed class JsonStreamOptions

Inheritance

object

JsonStreamOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EntityBuilderExtensions.AsEntityBuilder<T>(object?)

Properties

IgnoreNull

When true, object properties whose value is SQL NULL are omitted.

public bool IgnoreNull { get; init; }

Property Value

bool

Mode

The container shape. Defaults to Array.

public JsonStreamMode Mode { get; init; }

Property Value

JsonStreamMode

PropertyNamingPolicy

The policy applied to the projected property names, or null to keep them as-is.

public JsonNamingPolicy? PropertyNamingPolicy { get; init; }

Property Value

JsonNamingPolicy

Root

The property name of the wrapper object around an Array document ({"root":[...]}), or null for a bare array. Not allowed in NdJson.

public string? Root { get; init; }

Property Value

string

WriteIndented

When true, the array document is indented. Not allowed in NdJson.

public bool WriteIndented { get; init; }

Property Value

bool