API reference

TJsonFlow (unit `JsonFlow`)

Static class facade. No instance required.

Serialization methods

Method	Description
`ObjectToJsonString(AObject, AStoreClassName?)`	Serialize object to JSON string
`ObjectListToJsonString(AObjectList, AStoreClassName?)`	Serialize `TObjectList<TObject>` to JSON array string
`ObjectListToJsonString<T>(AObjectList, AStoreClassName?)`	Generic variant for `TObjectList<T>`
`JsonToObject<T>(AJson)`	Deserialize JSON string to new typed object (caller frees)
`JsonToObject<T>(AObject, AJson)`	Populate existing object in-place; returns `Boolean`
`JsonToObject(AJson, AObject)`	Populate existing `TObject` in-place
`JsonToObjectList<T>(AJson)`	Deserialize JSON array to `TObjectList<T>` (caller frees)
`JsonToObjectList(AJson, AType)`	Non-generic variant; takes `TClass` at runtime

Writer / reader accessors

Method	Description
`Write`	Returns the shared `IJSONWriter`
`Reader`	Returns the shared `IJSONReader`
`BeginObject(AValue?)`	Shortcut to `FJsonWriter.BeginObject`
`BeginArray`	Shortcut to `FJsonWriter.BeginArray`
`ParseFromFile(AFileName, AUtf8?)`	Parse JSON from file into shared reader
`SaveJsonToFile(AFileName, AUtf8?)`	Save reader's last parsed element to file

Middleware and settings

Method / Property	Description
`AddMiddleware(AEventMiddleware)`	Register a middleware on the shared builder
`FormatSettings` (read/write)	Global `TFormatSettings` for writer/reader/builder
`OnSetValue` (deprecated)	Use middlewares instead
`OnGetValue` (deprecated)	Use middlewares instead

TJSONWriter (unit `JsonFlow.Writer`)

Member	Description
`Create`	Default en-US format settings
`Create(AFormatSettings)`	Custom format settings
`Write(AElement, AIdent?)`	Returns compact or indented JSON string
`WriteToStream(AElement, AStream, AIdent?)`	UTF-8 encode to stream
`OnLog(ALogProc)`	Register log callback

TJSONReader (unit `JsonFlow.Reader`)

Member	Description
`Create`	Default settings, 64 KB buffer
`Create(ABufferSize)`	Custom buffer size (min 4 KB)
`Create(AFormatSettings)`	Custom format settings
`Create(AFormatSettings, ABufferSize)`	Both custom
`Read(AJson)`	Parse JSON string → `IJSONElement`
`ReadFromStream(AStream)`	Parse from stream → `IJSONElement`
`OnLog(ALogProc)`	Register log callback
`OnProgress(AProgress)`	Register progress callback (stream only)
`BufferSize`	Read/write buffer size property

TJSONSerializer (unit `JsonFlow.Serializer`)

Member	Description
`Create`	Default settings
`Create(AFormatSettings, AUseISO8601?)`	Custom format / ISO 8601 flag
`Create(AOptions)`	Full `TJSONSerializerOptions` record
`FromObject(AObject, AStoreClassName?)`	Object → `IJSONElement`
`ToObject(AElement, AObject)`	`IJSONElement` → populates existing object; returns `Boolean`
`OnLog(ALogProc)`	Register log callback
`Middlewares`	`TList<IEventMiddleware>` — register get/set middlewares
`Options`	Read/write `TJSONSerializerOptions`

TJSONComposer (unit `JsonFlow.Composer`)

All builder methods return IJSONComposer for chaining.

Construction

Create — empty composer.

Building JSON

BeginObject(AName?), EndObject, BeginArray(AName?), EndArray

Adding values

Add(AName, AValue) — overloaded for String, Integer, Double, Boolean, TDateTime, IJSONElement, Char, Variant, and typed arrays (TArray<Integer>, TArray<String>, etc.)

AddNull(AName), AddArray(AName, AValues[]), AddJSON(AName, AJson)

Convenience value methods

StringValue, NumberValue, IntegerValue, BooleanValue, NullValue, DateTimeValue

Callback-style nested builders

ObjectValue(AName, ACallback), ArrayValue(AName, ACallback)

Loading and manipulation

LoadJSON(AJson), SetValue(APath, AValue), RemoveKey(APath), Merge(AElement)

Array manipulation

AddToArray(APath, AValue), MergeArray(APath, AValues), RemoveFromArray(APath, AIndex), ReplaceArray(APath, AValues), AddObject(APath, AName)

NavigateTo(APath), GetCurrentPath, GetContextInfo

Output

AsJSON(AIdent?), ToJSON(AIdent?), ToElement, GetRoot

Utilities

Clone, Clear, ForEach(ACallback), OnLog(ALogProc), EnableDebugMode(AEnabled), GetCompositionTrace

Validation helpers

QuickValidate, ValidateStructure, IsValidJSON, GetValidationErrors, EnableRealTimeValidation(AEnabled)

Performance

GetPerformanceMetrics, OptimizeMemory, EnableLazyLoading(AEnabled), Benchmark(AOperation)

TJSONNavigator (unit `JsonFlow.Navigator`)

Member	Description
`Create(ARoot)`	Wrap an `IJSONElement` root
`GetValue(APath)`	Any element at path → `IJSONElement`
`GetObject(APath)`	`IJSONObject` at path
`GetArray(APath)`	`IJSONArray` at path
`GetString(APath)`	String value at path
`GetInteger(APath)`	`Int64` value at path
`GetFloat(APath)`	`Double` value at path
`GetBoolean(APath)`	`Boolean` value at path
`IsNull(APath)`	Returns `True` if value is null or missing
`Root`	Read-only property returning the root element

Path syntax: dot-notation (user.address.city) and array indices (items[0].name).

TSchemaValidator (unit `JsonFlow.SchemaValidator`)

Implements IJSONSchemaValidator.

Member	Description
`ParseSchema(ASchema)`	Load schema from `IJSONElement`
`Validate(AJson, AJsonSchema?)`	Validate JSON string (optionally with schema string)
`Validate(AElement, APath?)`	Validate `IJSONElement`
`GetErrors`	Returns `TArray<TValidationError>`
`GetVersion`	Returns detected schema version (`TJsonSchemaVersion`)
`GetLastError`	Returns last error message as string
`AddLog(AMessage)`	Append to internal log
`OnLog(ALogProc)`	Register log callback

TJsonFlow (unit JsonFlow)​

Serialization methods​

Writer / reader accessors​

Middleware and settings​

TJSONWriter (unit JsonFlow.Writer)​

TJSONReader (unit JsonFlow.Reader)​

TJSONSerializer (unit JsonFlow.Serializer)​

TJSONComposer (unit JsonFlow.Composer)​

Construction​

Building JSON​

Adding values​

Convenience value methods​

Callback-style nested builders​

Loading and manipulation​

Array manipulation​

Navigation​

Output​

Utilities​

Validation helpers​

Performance​

TJSONNavigator (unit JsonFlow.Navigator)​

TSchemaValidator (unit JsonFlow.SchemaValidator)​