toCodecJson<S>Derives a canonical JSON codec from a schema. The encoded form is Json, and
decoding produces the schema's Type.
export interface interface toCodecJson<S extends Constraint>Derives a canonical JSON codec from a schema. The encoded form is Json, and
decoding produces the schema's Type.
Type-level representation returned by
toCodecJson
.
toCodecJson<function (type parameter) S in toCodecJson<S extends Constraint>S extends Constraint> extends
interface BottomLazy<out Ast extends SchemaAST.AST, out Rebuild extends Top, in out TypeParameters extends ReadonlyArray<Constraint> = readonly [], out TypeMutability extends Mutability = "readonly", out TypeOptionality extends Optionality = "required", out TypeConstructorDefault extends ConstructorDefault = "no-default", out EncodedMutability extends Mutability = "readonly", out EncodedOptionality extends Optionality = "required">Lazy Bottom variant for schema implementations that compute their public
views on demand.
When to use
Use as an implementation base for schema interfaces that must expose
Bottom behavior without forcing TypeScript to eagerly evaluate expensive
Type, Encoded, or service views.
Details
The laziness is purely type-level; runtime behavior is unchanged.
BottomLazy keeps the structural operations inherited from Bottom, but
erases the expensive schema views to unknown. Concrete schema interfaces can
then redeclare the precise views they expose. This keeps wide schemas such as
Struct and Union cheaper when generic code reads a single view, while
preserving their exact public types.
BottomLazy<
function (type parameter) S in toCodecJson<S extends Constraint>S["ast"],
interface toCodecJson<S extends Constraint>Derives a canonical JSON codec from a schema. The encoded form is Json, and
decoding produces the schema's Type.
Type-level representation returned by
toCodecJson
.
toCodecJson<function (type parameter) S in toCodecJson<S extends Constraint>S>,
function (type parameter) S in toCodecJson<S extends Constraint>S["~type.parameters"],
function (type parameter) S in toCodecJson<S extends Constraint>S["~type.mutability"],
function (type parameter) S in toCodecJson<S extends Constraint>S["~type.optionality"],
function (type parameter) S in toCodecJson<S extends Constraint>S["~type.constructor.default"],
function (type parameter) S in toCodecJson<S extends Constraint>S["~encoded.mutability"],
function (type parameter) S in toCodecJson<S extends Constraint>S["~encoded.optionality"]
>
{
readonly "Type": function (type parameter) S in toCodecJson<S extends Constraint>S["Type"]
readonly "Encoded": type Json =
| string
| number
| boolean
| JsonArray
| JsonObject
| null
Recursive TypeScript type for any valid immutable JSON value: null,
number, boolean, string, a readonly array of Json values, or a
readonly record of string → Json. For the corresponding schema, see the
Json
const.
Schema that accepts and validates any immutable JSON-compatible value.
Example (Validating a JSON value)
import { Schema } from "effect"
const result = Schema.decodeUnknownOption(Schema.Json)({ key: [1, true, null] })
console.log(result._tag) // "Some"
Json
readonly "DecodingServices": function (type parameter) S in toCodecJson<S extends Constraint>S["DecodingServices"]
readonly "EncodingServices": function (type parameter) S in toCodecJson<S extends Constraint>S["EncodingServices"]
readonly "~type.make.in": function (type parameter) S in toCodecJson<S extends Constraint>S["~type.make.in"]
readonly "~type.make": function (type parameter) S in toCodecJson<S extends Constraint>S["~type.make"]
readonly "Iso": function (type parameter) S in toCodecJson<S extends Constraint>S["Iso"]
readonly toCodecJson<S extends Constraint>.schema: S extends Constraintschema: function (type parameter) S in toCodecJson<S extends Constraint>S
}
/**
* Derives a canonical JSON codec from a schema. The encoded form is `Json`, and
* decoding produces the schema's `Type`.
*
* @category Canonical Codecs
* @since 4.0.0
*/
export function function toCodecJson<
S extends Constraint
>(schema: S): toCodecJson<S>
Derives a canonical JSON codec from a schema. The encoded form is Json, and
decoding produces the schema's Type.
toCodecJson<function (type parameter) S in toCodecJson<S extends Constraint>(schema: S): toCodecJson<S>S extends Constraint>(schema: S extends Constraintschema: function (type parameter) S in toCodecJson<S extends Constraint>(schema: S): toCodecJson<S>S): interface toCodecJson<S extends Constraint>Derives a canonical JSON codec from a schema. The encoded form is Json, and
decoding produces the schema's Type.
Type-level representation returned by
toCodecJson
.
toCodecJson<function (type parameter) S in toCodecJson<S extends Constraint>(schema: S): toCodecJson<S>S> {
return const make: <S extends Constraint>(
ast: S["ast"],
options?: object
) => S
Creates a schema from an AST (Abstract Syntax Tree) node.
Details
This is the fundamental constructor for all schemas in the Effect Schema
library. It takes an AST node and wraps it in a fully-typed schema that
preserves all type information and provides the complete schema API.
The make function is used internally to create all primitive schemas like
String, Number, Boolean, etc., as well as more complex schemas. It's
the bridge between the untyped AST representation and the strongly-typed
schema.
make(const toCodecJsonTop: anytoCodecJsonTop(schema: S extends Constraintschema.Constraint["ast"]: SchemaAST.ASTast), { schema: S extends Constraintschema })
}