TimeZoneFromStringType-level representation of TimeZoneFromString.
export interface TimeZoneFromString 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<TimeZone, String> {
readonly "Rebuild": TimeZoneFromString
}
/**
* Schema that parses a time zone string into a `DateTime.TimeZone`.
*
* **Details**
*
* Decoding:
* - A `string` (IANA identifier or offset like `+03:00`) is decoded as a `DateTime.TimeZone`.
*
* Encoding:
* - A `DateTime.TimeZone` is encoded as a `string`.
*
* @category DateTime
* @since 4.0.0
*/
export const const TimeZoneFromString: TimeZoneFromStringconst TimeZoneFromString: {
Rebuild: TimeZoneFromString;
Type: To["Type"];
Encoded: From["Encoded"];
DecodingServices: To["DecodingServices"] | From["DecodingServices"] | RD;
EncodingServices: To["EncodingServices"] | From["EncodingServices"] | RE;
Iso: To["Iso"];
from: From;
to: To;
ast: Ast;
annotate: (annotations: Annotations.Bottom<DateTime.TimeZone, readonly []>) => TimeZoneFromString;
annotateKey: (annotations: Annotations.Key<DateTime.TimeZone>) => TimeZoneFromString;
check: (checks_0: SchemaAST.Check<DateTime.TimeZone>, ...checks: Array<SchemaAST.Check<DateTime.TimeZone>>) => TimeZoneFromString;
rebuild: (ast: SchemaAST.Declaration) => TimeZoneFromString;
make: (input: DateTime.TimeZone, options?: MakeOptions) => DateTime.TimeZone;
makeOption: (input: DateTime.TimeZone, options?: MakeOptions) => Option_.Option<DateTime.TimeZone>;
makeEffect: (input: DateTime.TimeZone, options?: MakeOptions) => Effect.Effect<DateTime.TimeZone, SchemaError, never>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Type-level representation of
TimeZoneFromString
.
Schema that parses a time zone string into a DateTime.TimeZone.
Details
Decoding:
- A
string (IANA identifier or offset like +03:00) is decoded as a DateTime.TimeZone.
Encoding:
- A
DateTime.TimeZone is encoded as a string.
TimeZoneFromString: TimeZoneFromString = const TimeZoneString: Stringconst TimeZoneString: {
Rebuild: Rebuild;
Iso: Iso;
ast: Ast;
Type: T;
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
annotate: (annotations: Annotations.Bottom<string, readonly []>) => String;
annotateKey: (annotations: Annotations.Key<string>) => String;
check: (checks_0: SchemaAST.Check<string>, ...checks: Array<SchemaAST.Check<string>>) => String;
rebuild: (ast: SchemaAST.String) => String;
make: (input: string, options?: MakeOptions) => string;
makeOption: (input: string, options?: MakeOptions) => Option_.Option<string>;
makeEffect: (input: string, options?: MakeOptions) => Effect.Effect<string, SchemaError, never>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
function decodeTo<TimeZone, Constraint, never, never>(to: TimeZone, transformation: {
readonly decode: SchemaGetter.Getter<DateTime.TimeZone, unknown, never>;
readonly encode: SchemaGetter.Getter<unknown, DateTime.TimeZone, never>;
}): (from: Constraint) => decodeTo<TimeZone, 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(const TimeZone: TimeZoneconst TimeZone: {
Rebuild: TimeZone;
Iso: Iso;
ast: Ast;
Type: T;
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
annotate: (annotations: Annotations.Bottom<DateTime.TimeZone, readonly []>) => TimeZone;
annotateKey: (annotations: Annotations.Key<DateTime.TimeZone>) => TimeZone;
check: (checks_0: SchemaAST.Check<DateTime.TimeZone>, ...checks: Array<SchemaAST.Check<DateTime.TimeZone>>) => TimeZone;
rebuild: (ast: SchemaAST.Declaration) => TimeZone;
make: (input: DateTime.TimeZone, options?: MakeOptions) => DateTime.TimeZone;
makeOption: (input: DateTime.TimeZone, options?: MakeOptions) => Option_.Option<DateTime.TimeZone>;
makeEffect: (input: DateTime.TimeZone, options?: MakeOptions) => Effect.Effect<DateTime.TimeZone, SchemaError, never>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Type-level representation of
TimeZone
.
Schema for DateTime.TimeZone values.
Details
Default JSON serializer:
- encodes
DateTime.TimeZone as a string (IANA identifier or offset like
+03:00)
TimeZone, import SchemaTransformationSchemaTransformation.const timeZoneFromString: Transformation<
DateTime.TimeZone,
string
>
const timeZoneFromString: {
_tag: 'Transformation';
decode: SchemaGetter.Getter<T, E, RD>;
encode: SchemaGetter.Getter<E, T, RE>;
flip: () => SchemaTransformation.Transformation<string, DateTime.TimeZone, never, never>;
compose: (other: SchemaTransformation.Transformation<T2, DateTime.TimeZone, RD2, RE2>) => SchemaTransformation.Transformation<T2, string, RD2, RE2>;
}
Decodes a string into a DateTime.TimeZone and encodes a time zone back to
its string representation.
When to use
Use when you need a schema transformation to accept either an IANA time-zone
identifier or an offset string and produce a general DateTime.TimeZone.
Details
Accepted decode inputs include valid IANA identifiers and offset strings such
as "+03:00". Decode fails with InvalidValue when the string cannot be
parsed as a time zone.
timeZoneFromString)
)