RetainedParseResultModule

PackageReified.Schema
Functions for creating and rendering retained schema parse results.

Summary

NameSignatureSynopsis
Representation
ErrorsForthis.ErrorsForReturns schema errors attached exactly to the supplied structured data path.
ErrorsForthis.ErrorsForReturns schema errors attached exactly to the supplied path.
TryValuethis.TryValueReturns the parsed value when input parsing succeeded.
IsValidthis.IsValidReturns true when input parsing produced a trusted model.
Valuethis.ValueReturns the parsed value or raises when input parsing failed.
Errorsthis.ErrorsReturns path-aware issues from a failed parse, or an empty list after a successful parse.
InputInputThe structured boundary data that was parsed.
ResultResultThe parsed model or accumulated schema failures.
Operations
createRetainedParseResult.create input resultRetains structured data alongside an existing schema parse result.
renderErrorsRetainedParseResult.renderErrors parsedRenders one line for every failed schema issue.

Representation

kind:member

ErrorsFor

this.ErrorsFor
Member
Returns schema errors attached exactly to the supplied structured data path.

Parameters

NameTypeDescription
pathstring

Returns

SchemaError list
kind:member

ErrorsFor

this.ErrorsFor
Member
Returns schema errors attached exactly to the supplied path.

Parameters

NameTypeDescription
pathSchemaPath

Returns

SchemaError list
kind:member

TryValue

this.TryValue
Member
Returns the parsed value when input parsing succeeded.

Returns

'value option
kind:member

IsValid

this.IsValid
Member
Returns true when input parsing produced a trusted model.

Returns

bool
kind:member

Value

this.Value
Member
Returns the parsed value or raises when input parsing failed.

Returns

'value
kind:member

Errors

this.Errors
Member
Returns path-aware issues from a failed parse, or an empty list after a successful parse.

Returns

SchemaIssue list
kind:member

Input

Input
Member
The structured boundary data that was parsed.

Returns

Data
kind:member

Result

Result
Member
The parsed model or accumulated schema failures.

Returns

Result<'value, SchemaErrors>

Operations

kind:member

create

RetainedParseResult.create input result
Member
Retains structured data alongside an existing schema parse result.

Parameters

NameTypeDescription
inputData
resultResult<'value, SchemaErrors>

Returns

RetainedParseResult<'value>
kind:member

renderErrors

RetainedParseResult.renderErrors parsed
Member
Renders one line for every failed schema issue.

Parameters

NameTypeDescription
parsedRetainedParseResult<'value>

Returns

string list