OptionFromNullOr<S>Decodes a nullable, required value T to a required Option<T> value.
Details
Decoding maps null to None and all other values to Some. Encoding maps
None to null and maps Some to its value.
export interface interface OptionFromNullOr<S extends Constraint>Decodes a nullable, required value T to a required Option<T> value.
Details
Decoding maps null to None and all other values to Some. Encoding maps
None to null and maps Some to its value.
Type-level representation returned by
OptionFromNullOr
.
OptionFromNullOr<function (type parameter) S in OptionFromNullOr<S extends Constraint>S extends Constraint> extends interface decodeTo<To extends Constraint, From extends Constraint, RD = never, RE = never>Creates a schema that transforms from a source schema to a target schema.
When to use
Use when decoding should change the schema's decoded type or encoded shape,
with an optional custom bidirectional transformation.
Details
Call it with the target schema to and then pipe the source schema from
into the returned function. The resulting schema decodes from
From["Encoded"] to To["Type"] and encodes from To["Type"] back to
From["Encoded"].
When no transformation is provided, SchemaTransformation.passthrough() is
used, so From["Type"] must already be compatible with To["Encoded"].
The resulting schema combines decoding and encoding services from both
schemas and any custom transformation.
Gotchas
In a custom transformation, decode maps From["Type"] to To["Encoded"]
and is used on the encoding path, while encode maps To["Encoded"] to
From["Type"] and is used on the decoding path.
Example (Transforming strings to numbers with a schema transformation)
import { Schema, SchemaGetter } from "effect"
const NumberFromString = Schema.String.pipe(
Schema.decodeTo(
Schema.Number,
{
decode: SchemaGetter.transform((s) => Number(s)),
encode: SchemaGetter.transform((n) => String(n))
}
)
)
const result = Schema.decodeUnknownSync(NumberFromString)("123")
// result: 123
Type-level representation returned by
decodeTo
.
decodeTo<interface Option<A extends Constraint>Schema for Option<A> values.
Type-level representation returned by
Option
.
Option<interface toType<S extends Constraint>Type-level representation returned by
toType
.
Extracts the type-side schema: sets Encoded to equal the decoded Type,
discarding the encoding transformation path.
toType<function (type parameter) S in OptionFromNullOr<S extends Constraint>S>>, interface NullOr<S extends Constraint>Type-level representation returned by
NullOr
.
Creates a union schema of S | null.
NullOr<function (type parameter) S in OptionFromNullOr<S extends Constraint>S>> {
readonly "Rebuild": interface OptionFromNullOr<S extends Constraint>Decodes a nullable, required value T to a required Option<T> value.
Details
Decoding maps null to None and all other values to Some. Encoding maps
None to null and maps Some to its value.
Type-level representation returned by
OptionFromNullOr
.
OptionFromNullOr<function (type parameter) S in OptionFromNullOr<S extends Constraint>S>
}
/**
* Decodes a nullable, required value `T` to a required `Option<T>` value.
*
* **Details**
*
* Decoding maps `null` to `None` and all other values to `Some`. Encoding maps
* `None` to `null` and maps `Some` to its value.
*
* @category Option
* @since 3.10.0
*/
export function function OptionFromNullOr<
S extends Constraint
>(schema: S): OptionFromNullOr<S>
Decodes a nullable, required value T to a required Option<T> value.
Details
Decoding maps null to None and all other values to Some. Encoding maps
None to null and maps Some to its value.
OptionFromNullOr<function (type parameter) S in OptionFromNullOr<S extends Constraint>(schema: S): OptionFromNullOr<S>S extends Constraint>(schema: S extends Constraintschema: function (type parameter) S in OptionFromNullOr<S extends Constraint>(schema: S): OptionFromNullOr<S>S): interface OptionFromNullOr<S extends Constraint>Decodes a nullable, required value T to a required Option<T> value.
Details
Decoding maps null to None and all other values to Some. Encoding maps
None to null and maps Some to its value.
Type-level representation returned by
OptionFromNullOr
.
OptionFromNullOr<function (type parameter) S in OptionFromNullOr<S extends Constraint>(schema: S): OptionFromNullOr<S>S> {
return const NullOr: NullOrLambda
;<S>(self: S) => NullOr<S>
Type-level representation returned by
NullOr
.
Creates a union schema of S | null.
NullOr(schema: S extends Constraintschema).pipe(function decodeTo<Option<toType<S>>, Constraint, never, never>(to: Option<toType<S>>, transformation: {
readonly decode: SchemaGetter.Getter<Option_.Option<A["Encoded"]>, unknown, never>;
readonly encode: SchemaGetter.Getter<unknown, Option_.Option<A["Encoded"]>, never>;
}): (from: Constraint) => decodeTo<Option<toType<S>>, Constraint, never, never> (+1 overload)
Creates a schema that transforms from a source schema to a target schema.
When to use
Use when decoding should change the schema's decoded type or encoded shape,
with an optional custom bidirectional transformation.
Details
Call it with the target schema to and then pipe the source schema from
into the returned function. The resulting schema decodes from
From["Encoded"] to To["Type"] and encodes from To["Type"] back to
From["Encoded"].
When no transformation is provided, SchemaTransformation.passthrough() is
used, so From["Type"] must already be compatible with To["Encoded"].
The resulting schema combines decoding and encoding services from both
schemas and any custom transformation.
Gotchas
In a custom transformation, decode maps From["Type"] to To["Encoded"]
and is used on the encoding path, while encode maps To["Encoded"] to
From["Type"] and is used on the decoding path.
Example (Transforming strings to numbers with a schema transformation)
import { Schema, SchemaGetter } from "effect"
const NumberFromString = Schema.String.pipe(
Schema.decodeTo(
Schema.Number,
{
decode: SchemaGetter.transform((s) => Number(s)),
encode: SchemaGetter.transform((n) => String(n))
}
)
)
const result = Schema.decodeUnknownSync(NumberFromString)("123")
// result: 123
decodeTo(
function Option<A extends Constraint>(
value: A
): Option<A>
Schema for Option<A> values.
Option(const toType: toTypeLambda
;<S>(self: S) => toType<S>
Type-level representation returned by
toType
.
Extracts the type-side schema: sets Encoded to equal the decoded Type,
discarding the encoding transformation path.
toType(schema: S extends Constraintschema)),
import SchemaTransformationSchemaTransformation.function optionFromNullOr<
T
>(): Transformation<Option.Option<T>, T | null>
Decodes T | null into Option<T> and encodes Option<T> back to
T | null.
When to use
Use when you need a schema transformation to convert nullable API fields to
Option.
Details
Decoding maps null to Option.none() and non-null values to
Option.some(value). Encoding maps Option.none() to null and
Option.some(value) to value. The transformation is pure and synchronous.
Example (Converting nullable values to an Option)
import { Schema, SchemaTransformation } from "effect"
const schema = Schema.NullOr(Schema.String).pipe(
Schema.decodeTo(
Schema.Option(Schema.String),
SchemaTransformation.optionFromNullOr()
)
)
optionFromNullOr()
))
}