Header menu logo CodecMapper

KeyValue Module

Flat `string,string` contract projection for config-style schemas. This backend is intentionally narrower than JSON or XML: it targets flattened key/value surfaces such as app settings or environment variables.

Types and nested modules

Type/Module Description

Options (Module)

Codec<'T>

A compiled flat key/value codec for a specific schema.

CompiledCodec

Options (Type)

Options controlling how flattened keys are named.

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 key/value 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` remains as the shorter schema-to-codec alias for callers that prefer the direct compile step under the default options.

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

compile schema

Full Usage: compile schema

Parameters:
Returns: Codec<'T>

Compiles a schema into a reusable flat key/value codec using dotted keys.

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

compileUsing options schema

Full Usage: compileUsing options schema

Parameters:
Returns: Codec<'T>

Compiles a schema into a reusable flat key/value codec using explicit options.

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

deserialize codec values

Full Usage: deserialize codec values

Parameters:
    codec : Codec<'T>
    values : Map<string, string>

Returns: 'T

Deserializes a flat key/value map using a previously compiled codec.

codec : Codec<'T>
values : Map<string, string>
Returns: 'T

deserializeSeq codec values

Full Usage: deserializeSeq codec values

Parameters:
    codec : Codec<'T>
    values : (string * string) seq

Returns: 'T

Deserializes any sequence of key/value pairs by first normalizing it to a map.

codec : Codec<'T>
values : (string * string) seq
Returns: 'T

serialize codec value

Full Usage: serialize codec value

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

Returns: Map<string, string>

Serializes a value to a flat key/value map using a previously compiled codec.

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

Type something to start searching.