RetainedParseResultRecord

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

Fields

NameTypeDescription
ErrorsForthis.ErrorsForReturns schema errors attached exactly to the supplied structured data path.
ErrorsForthis.ErrorsForReturns schema errors attached exactly to the supplied path.
IsValidthis.IsValidReturns true when input parsing produced a trusted model.
Valuethis.ValueReturns the parsed value or raises when input parsing failed.
TryValuethis.TryValueReturns the parsed value when input parsing succeeded.
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.

Specification

Kind
Record
Members
2
Examples
0
createSignature
RetainedParseResult.create input result
renderErrorsSignature
RetainedParseResult.renderErrors parsed

Summary

NameSignatureSynopsis
Operations
createRetainedParseResult.create input resultRetains structured data alongside an existing schema parse result.
renderErrorsRetainedParseResult.renderErrors parsedRenders one line for every failed schema issue.

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