Header menu logo CodecMapper

Yaml Module

YAML projection layered on top of the portable `JsonValue` model. This intentionally supports a small YAML subset suitable for config-style contracts: mappings, sequences, scalars, `null`, and quoted/plain strings.

Types

Type Description

Codec<'T>

Functions and values

Function or value Description

buildAndCompile builder

Full Usage: buildAndCompile builder

Parameters:
Returns: Codec<'T>
Modifiers: inline
Type parameters: 'T

Inline schema pipelines read more clearly when the final `build` and YAML compile step collapse into one terminal pipeline stage.

builder : Builder<'T, 'T>
Returns: Codec<'T>

codec schema

Full Usage: codec schema

Parameters:
Returns: Codec<'T>

`codec` mirrors the other format modules for callers that still prefer the shorter schema-to-codec alias over the longer `compile` name.

schema : Schema<'T>
Returns: Codec<'T>

compile schema

Full Usage: compile schema

Parameters:
Returns: Codec<'T>

Compiles a schema into a reusable YAML codec. The YAML surface is intentionally small and config-oriented. It reuses the compiled JSON codec and a `JsonValue` projection instead of adding a second full schema compiler.

schema : Schema<'T>
Returns: Codec<'T>

deserialize codec yaml

Full Usage: deserialize codec yaml

Parameters:
    codec : Codec<'T>
    yaml : string

Returns: 'T

Deserializes a YAML payload using a previously compiled codec.

codec : Codec<'T>
yaml : string
Returns: 'T

serialize codec value

Full Usage: serialize codec value

Parameters:
    codec : Codec<'T>
    value : 'T

Returns: string

Serializes a value to YAML using a previously compiled codec.

codec : Codec<'T>
value : 'T
Returns: string

Type something to start searching.