Transformation<string, string, never, never>Decodes a URI component encoded string into a UTF-8 string and encodes a UTF-8 string into a URI component encoded string.
When to use
Use when you need a schema transformation to store structured data in URL
query parameters or fragments, such as composing with Schema.parseJson to
round-trip JSON through a URL.
Details
Decoding calls decodeURIComponent and fails if the input contains malformed
percent-encoding sequences. Encoding calls encodeURIComponent.
Example (Defining a URI component schema)
import { Schema, SchemaTransformation } from "effect"
const schema = Schema.String.pipe(
Schema.decodeTo(Schema.String, SchemaTransformation.stringFromUriComponent)
)export const const stringFromUriComponent: Transformation<
string,
string
>
const stringFromUriComponent: {
_tag: 'Transformation';
decode: SchemaGetter.Getter<T, E, RD>;
encode: SchemaGetter.Getter<E, T, RE>;
flip: () => Transformation<string, string, never, never>;
compose: (other: Transformation<T2, string, RD2, RE2>) => Transformation<T2, string, RD2, RE2>;
}
Decodes a URI component encoded string into a UTF-8 string and encodes a
UTF-8 string into a URI component encoded string.
When to use
Use when you need a schema transformation to store structured data in URL
query parameters or fragments, such as composing with Schema.parseJson to
round-trip JSON through a URL.
Details
Decoding calls decodeURIComponent and fails if the input contains malformed
percent-encoding sequences. Encoding calls encodeURIComponent.
Example (Defining a URI component schema)
import { Schema, SchemaTransformation } from "effect"
const schema = Schema.String.pipe(
Schema.decodeTo(Schema.String, SchemaTransformation.stringFromUriComponent)
)
stringFromUriComponent: class Transformation<in out T, in out E, RD = never, RE = never>class Transformation {
_tag: 'Transformation';
decode: SchemaGetter.Getter<T, E, RD>;
encode: SchemaGetter.Getter<E, T, RE>;
flip: () => Transformation<E, T, RE, RD>;
compose: <T2, RD2, RE2>(other: Transformation<T2, T, RD2, RE2>) => Transformation<T2, E, RD | RD2, RE | RE2>;
}
Represents a bidirectional transformation between a decoded type T and an encoded
type E, built from a pair of Getters.
When to use
Use when you need a schema transformation that defines how a schema converts
between two representations.
- You want to compose multiple transformations into a pipeline.
- You want to flip a transformation to swap decode/encode.
Details
This is the primary building block for Schema.decodeTo, Schema.encodeTo,
Schema.decode, Schema.encode, and Schema.link. Each direction is a
SchemaGetter.Getter that handles optionality, failure, and Effect services.
- Immutable —
flip() and compose() return new instances.
flip() swaps the decode and encode getters.compose(other) chains: this.decode then other.decode for decoding,
other.encode then this.encode for encoding.
Example (Composing two transformations)
import { SchemaTransformation } from "effect"
const trimAndLower = SchemaTransformation.trim().compose(
SchemaTransformation.toLowerCase()
)
// decode: trim then lowercase
// encode: passthrough (both directions)
Transformation<string, string> = new constructor Transformation<string, string, never, never>(decode: SchemaGetter.Getter<string, string, never>, encode: SchemaGetter.Getter<string, string, never>): Transformation<string, string, never, never>Represents a bidirectional transformation between a decoded type T and an encoded
type E, built from a pair of Getters.
When to use
Use when you need a schema transformation that defines how a schema converts
between two representations.
- You want to compose multiple transformations into a pipeline.
- You want to flip a transformation to swap decode/encode.
Details
This is the primary building block for Schema.decodeTo, Schema.encodeTo,
Schema.decode, Schema.encode, and Schema.link. Each direction is a
SchemaGetter.Getter that handles optionality, failure, and Effect services.
- Immutable —
flip() and compose() return new instances.
flip() swaps the decode and encode getters.compose(other) chains: this.decode then other.decode for decoding,
other.encode then this.encode for encoding.
Example (Composing two transformations)
import { SchemaTransformation } from "effect"
const trimAndLower = SchemaTransformation.trim().compose(
SchemaTransformation.toLowerCase()
)
// decode: trim then lowercase
// encode: passthrough (both directions)
Transformation(
import SchemaGetterSchemaGetter.decodeUriComponent(),
import SchemaGetterSchemaGetter.encodeUriComponent()
)