Schema Projections

Sometimes, you may want to create a new schema based on an existing one, focusing specifically on either its Type or Encoded aspect. The Schema module provides several functions to make this possible.

typeSchema

The Schema.typeSchema function is used to extract the Type portion of a schema, resulting in a new schema that retains only the type-specific properties from the original schema. This excludes any initial encoding or transformation logic applied to the original schema.

Function Signature

declare const typeSchema: <A, I, R>(schema: Schema<A, I, R>) => Schema<A>

Example (Extracting Only Type-Specific Properties)

1
import { 
import Schema
Schema } from "effect"
2

3
const 
const Original: Schema.Struct<{
    quantity: Schema.filter<typeof Schema.NumberFromString>;
}>
Original = 
import Schema
Schema.
function Struct<{
    quantity: Schema.filter<typeof Schema.NumberFromString>;
}>(fields: {
    quantity: Schema.filter<typeof Schema.NumberFromString>;
}): Schema.Struct<{
    quantity: Schema.filter<typeof Schema.NumberFromString>;
}> (+1 overload)@since ― 3.10.0
Struct({
4
  
quantity: Schema.filter<typeof Schema.NumberFromString>
quantity: 
import Schema
Schema.
class NumberFromString
This schema transforms a string into a number by parsing the string using the parse function of the effect/Number module.
It returns an error if the value can't be converted (for example when non-numeric characters are provided).
The following special string values are supported: "NaN", "Infinity", "-Infinity".
@since ― 3.10.0
NumberFromString.
Pipeable.pipe<typeof Schema.NumberFromString, Schema.filter<typeof Schema.NumberFromString>>(this: typeof Schema.NumberFromString, ab: (_: typeof Schema.NumberFromString) => Schema.filter<typeof Schema.NumberFromString>): Schema.filter<...> (+21 overloads)
pipe(
import Schema
Schema.
const greaterThanOrEqualTo: <typeof Schema.NumberFromString>(minimum: number, annotations?: Schema.Annotations.Filter<number, number> | undefined) => <A>(self: typeof Schema.NumberFromString & Schema.Schema<...>) => Schema.filter<...>
This filter checks whether the provided number is greater than or equal to the specified minimum.
@since ― 3.10.0
greaterThanOrEqualTo(2))
5
})
6

7
// This creates a schema where 'quantity' is defined as a number
8
// that must be greater than or equal to 2.
9
const 
const TypeSchema: Schema.SchemaClass<{
    readonly quantity: number;
}, {
    readonly quantity: number;
}, never>
TypeSchema = 
import Schema
Schema.
const typeSchema: <{
    readonly quantity: number;
}, {
    readonly quantity: string;
}, never>(schema: Schema.Schema<{
    readonly quantity: number;
}, {
    readonly quantity: string;
}, never>) => Schema.SchemaClass<{
    readonly quantity: number;
}, {
    readonly quantity: number;
}, never>
The typeSchema function allows you to extract the Type portion of a
schema, creating a new schema that conforms to the properties defined in the
original schema without considering the initial encoding or transformation
processes.
@since ― 3.10.0
typeSchema(
const Original: Schema.Struct<{
    quantity: Schema.filter<typeof Schema.NumberFromString>;
}>
Original)
10

11
// TypeSchema is equivalent to:
12
const 
const TypeSchema2: Schema.Struct<{
    quantity: Schema.filter<typeof Schema.Number>;
}>
TypeSchema2 = 
import Schema
Schema.
function Struct<{
    quantity: Schema.filter<typeof Schema.Number>;
}>(fields: {
    quantity: Schema.filter<typeof Schema.Number>;
}): Schema.Struct<{
    quantity: Schema.filter<typeof Schema.Number>;
}> (+1 overload)@since ― 3.10.0
Struct({
13
  
quantity: Schema.filter<typeof Schema.Number>
quantity: 
import Schema
Schema.
class Number
export Number@since ― 3.10.0
Number.
Pipeable.pipe<typeof Schema.Number, Schema.filter<typeof Schema.Number>>(this: typeof Schema.Number, ab: (_: typeof Schema.Number) => Schema.filter<typeof Schema.Number>): Schema.filter<...> (+21 overloads)
pipe(
import Schema
Schema.
const greaterThanOrEqualTo: <typeof Schema.Number>(minimum: number, annotations?: Schema.Annotations.Filter<number, number> | undefined) => <A>(self: typeof Schema.Number & Schema.Schema<A, number, never>) => Schema.filter<...>
This filter checks whether the provided number is greater than or equal to the specified minimum.
@since ― 3.10.0
greaterThanOrEqualTo(2))
14
})

encodedSchema

The Schema.encodedSchema function enables you to extract the Encoded portion of a schema, creating a new schema that matches the original properties but omits any refinements or transformations applied to the schema.

Function Signature

declare const encodedSchema: <A, I, R>(
  schema: Schema<A, I, R>
) => Schema<I>

Example (Extracting Encoded Properties Only)

1
import { 
import Schema
Schema } from "effect"
2

3
const 
const Original: Schema.Struct<{
    quantity: Schema.filter<typeof Schema.String>;
}>
Original = 
import Schema
Schema.
function Struct<{
    quantity: Schema.filter<typeof Schema.String>;
}>(fields: {
    quantity: Schema.filter<typeof Schema.String>;
}): Schema.Struct<{
    quantity: Schema.filter<typeof Schema.String>;
}> (+1 overload)@since ― 3.10.0
Struct({
4
  
quantity: Schema.filter<typeof Schema.String>
quantity: 
import Schema
Schema.
class String
export String@since ― 3.10.0
String.
Pipeable.pipe<typeof Schema.String, Schema.filter<typeof Schema.String>>(this: typeof Schema.String, ab: (_: typeof Schema.String) => Schema.filter<typeof Schema.String>): Schema.filter<...> (+21 overloads)
pipe(
import Schema
Schema.
const minLength: <typeof Schema.String>(minLength: number, annotations?: Schema.Annotations.Filter<string, string> | undefined) => <A>(self: typeof Schema.String & Schema.Schema<A, string, never>) => Schema.filter<...>@since ― 3.10.0
minLength(3))
5
})
6

7
// This creates a schema where 'quantity' is just a string,
8
// disregarding the minLength refinement.
9
const 
const Encoded: Schema.SchemaClass<{
    readonly quantity: string;
}, {
    readonly quantity: string;
}, never>
Encoded = 
import Schema
Schema.
const encodedSchema: <{
    readonly quantity: string;
}, {
    readonly quantity: string;
}, never>(schema: Schema.Schema<{
    readonly quantity: string;
}, {
    readonly quantity: string;
}, never>) => Schema.SchemaClass<{
    readonly quantity: string;
}, {
    readonly quantity: string;
}, never>
The encodedSchema function allows you to extract the Encoded portion of a
schema, creating a new schema that conforms to the properties defined in the
original schema without retaining any refinements or transformations that
were applied previously.
@since ― 3.10.0
encodedSchema(
const Original: Schema.Struct<{
    quantity: Schema.filter<typeof Schema.String>;
}>
Original)
10

11
// Encoded is equivalent to:
12
const 
const Encoded2: Schema.Struct<{
    quantity: typeof Schema.String;
}>
Encoded2 = 
import Schema
Schema.
function Struct<{
    quantity: typeof Schema.String;
}>(fields: {
    quantity: typeof Schema.String;
}): Schema.Struct<{
    quantity: typeof Schema.String;
}> (+1 overload)@since ― 3.10.0
Struct({
13
  
quantity: typeof Schema.String
quantity: 
import Schema
Schema.
class String
export String@since ― 3.10.0
String
14
})

encodedBoundSchema

The Schema.encodedBoundSchema function is similar to Schema.encodedSchema but preserves the refinements up to the first transformation point in the original schema.

Function Signature

declare const encodedBoundSchema: <A, I, R>(
  schema: Schema<A, I, R>
) => Schema<I>

The term “bound” in this context refers to the boundary up to which refinements are preserved when extracting the encoded form of a schema. It essentially marks the limit to which initial validations and structure are maintained before any transformations are applied.

Example (Retaining Initial Refinements Only)

1
import { 
import Schema
Schema } from "effect"
2

3
const 
const Original: Schema.Struct<{
    foo: Schema.transform<Schema.filter<typeof Schema.String>, typeof Schema.Trim>;
}>
Original = 
import Schema
Schema.
function Struct<{
    foo: Schema.transform<Schema.filter<typeof Schema.String>, typeof Schema.Trim>;
}>(fields: {
    foo: Schema.transform<Schema.filter<typeof Schema.String>, typeof Schema.Trim>;
}): Schema.Struct<...> (+1 overload)@since ― 3.10.0
Struct({
4
  
foo: Schema.transform<Schema.filter<typeof Schema.String>, typeof Schema.Trim>
foo: 
import Schema
Schema.
class String
export String@since ― 3.10.0
String.
Pipeable.pipe<typeof Schema.String, Schema.filter<typeof Schema.String>, Schema.transform<Schema.filter<typeof Schema.String>, typeof Schema.Trim>>(this: typeof Schema.String, ab: (_: typeof Schema.String) => Schema.filter<...>, bc: (_: Schema.filter<...>) => Schema.transform<...>): Schema.transform<...> (+21 overloads)
pipe(
5
    
import Schema
Schema.
const minLength: <typeof Schema.String>(minLength: number, annotations?: Schema.Annotations.Filter<string, string> | undefined) => <A>(self: typeof Schema.String & Schema.Schema<A, string, never>) => Schema.filter<...>@since ― 3.10.0
minLength(3),
6
    
import Schema
Schema.
const compose: <typeof Schema.Trim, Schema.filter<typeof Schema.String>, string>(to: typeof Schema.Trim & Schema.Schema<string, string, never>) => (from: Schema.filter<typeof Schema.String>) => Schema.transform<...> (+7 overloads)@since ― 3.10.0
compose(
import Schema
Schema.
class Trim
This schema allows removing whitespaces from the beginning and end of a string.
@since ― 3.10.0
Trim)
7
  )
8
})
9

10
// The EncodedBoundSchema schema preserves the minLength(3) refinement,
11
// ensuring the string length condition is enforced
12
// but omits the Schema.Trim transformation.
13
const 
const EncodedBoundSchema: Schema.SchemaClass<{
    readonly foo: string;
}, {
    readonly foo: string;
}, never>
EncodedBoundSchema = 
import Schema
Schema.
const encodedBoundSchema: <{
    readonly foo: string;
}, {
    readonly foo: string;
}, never>(schema: Schema.Schema<{
    readonly foo: string;
}, {
    readonly foo: string;
}, never>) => Schema.SchemaClass<{
    readonly foo: string;
}, {
    readonly foo: string;
}, never>
The encodedBoundSchema function is similar to encodedSchema but preserves
the refinements up to the first transformation point in the original schema.
@since ― 3.10.0
encodedBoundSchema(
const Original: Schema.Struct<{
    foo: Schema.transform<Schema.filter<typeof Schema.String>, typeof Schema.Trim>;
}>
Original)
14

15
// EncodedBoundSchema is equivalent to:
16
const 
const EncodedBoundSchema2: Schema.Struct<{
    foo: Schema.filter<typeof Schema.String>;
}>
EncodedBoundSchema2 = 
import Schema
Schema.
function Struct<{
    foo: Schema.filter<typeof Schema.String>;
}>(fields: {
    foo: Schema.filter<typeof Schema.String>;
}): Schema.Struct<{
    foo: Schema.filter<typeof Schema.String>;
}> (+1 overload)@since ― 3.10.0
Struct({
17
  
foo: Schema.filter<typeof Schema.String>
foo: 
import Schema
Schema.
class String
export String@since ― 3.10.0
String.
Pipeable.pipe<typeof Schema.String, Schema.filter<typeof Schema.String>>(this: typeof Schema.String, ab: (_: typeof Schema.String) => Schema.filter<typeof Schema.String>): Schema.filter<...> (+21 overloads)
pipe(
import Schema
Schema.
const minLength: <typeof Schema.String>(minLength: number, annotations?: Schema.Annotations.Filter<string, string> | undefined) => <A>(self: typeof Schema.String & Schema.Schema<A, string, never>) => Schema.filter<...>@since ― 3.10.0
minLength(3))
18
})