toCodecStringTree<S>Converts a schema to the StringTree canonical codec, where every leaf value becomes a string while preserving the original structure.
Details
Declarations are converted to undefined (unless they have a
toCodecJson or toCodec annotation).
export interface interface toCodecStringTree<S extends Constraint>Converts a schema to the StringTree canonical codec, where every leaf value
becomes a string while preserving the original structure.
Details
Declarations are converted to undefined (unless they have a
toCodecJson or toCodec annotation).
Type-level representation returned by
toCodecStringTree
.
toCodecStringTree<function (type parameter) S in toCodecStringTree<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 toCodecStringTree<S extends Constraint>S["ast"],
interface toCodecStringTree<S extends Constraint>Converts a schema to the StringTree canonical codec, where every leaf value
becomes a string while preserving the original structure.
Details
Declarations are converted to undefined (unless they have a
toCodecJson or toCodec annotation).
Type-level representation returned by
toCodecStringTree
.
toCodecStringTree<function (type parameter) S in toCodecStringTree<S extends Constraint>S>,
interface ReadonlyArray<T>ReadonlyArray<Constraint>,
function (type parameter) S in toCodecStringTree<S extends Constraint>S["~type.mutability"],
function (type parameter) S in toCodecStringTree<S extends Constraint>S["~type.optionality"],
function (type parameter) S in toCodecStringTree<S extends Constraint>S["~type.constructor.default"],
function (type parameter) S in toCodecStringTree<S extends Constraint>S["~encoded.mutability"],
function (type parameter) S in toCodecStringTree<S extends Constraint>S["~encoded.optionality"]
>
{
readonly "Type": function (type parameter) S in toCodecStringTree<S extends Constraint>S["Type"]
readonly "Encoded": type StringTree =
| string
| TreeRecord<string | undefined>
| readonly Tree<string | undefined>[]
| undefined
A
Tree
of string | undefined nodes. Leaf values are either a
string representation or undefined for opaque/declaration types.
StringTree
readonly "DecodingServices": function (type parameter) S in toCodecStringTree<S extends Constraint>S["DecodingServices"]
readonly "EncodingServices": function (type parameter) S in toCodecStringTree<S extends Constraint>S["EncodingServices"]
readonly "~type.make.in": function (type parameter) S in toCodecStringTree<S extends Constraint>S["~type.make.in"]
readonly "~type.make": function (type parameter) S in toCodecStringTree<S extends Constraint>S["~type.make"]
readonly "Iso": function (type parameter) S in toCodecStringTree<S extends Constraint>S["Iso"]
readonly toCodecStringTree<S extends Constraint>.schema: S extends Constraintschema: function (type parameter) S in toCodecStringTree<S extends Constraint>S
}
/**
* Converts a schema to the StringTree canonical codec, where every leaf value
* becomes a string while preserving the original structure.
*
* **Details**
*
* Declarations are converted to `undefined` (unless they have a
* `toCodecJson` or `toCodec` annotation).
*
* @category Canonical Codecs
* @since 4.0.0
*/
export function function toCodecStringTree<
S extends Constraint
>(schema: S): toCodecStringTree<S>
Converts a schema to the StringTree canonical codec, where every leaf value
becomes a string while preserving the original structure.
Details
Declarations are converted to undefined (unless they have a
toCodecJson or toCodec annotation).
toCodecStringTree<function (type parameter) S in toCodecStringTree<S extends Constraint>(schema: S): toCodecStringTree<S>S extends Constraint>(schema: S extends Constraintschema: function (type parameter) S in toCodecStringTree<S extends Constraint>(schema: S): toCodecStringTree<S>S): interface toCodecStringTree<S extends Constraint>Converts a schema to the StringTree canonical codec, where every leaf value
becomes a string while preserving the original structure.
Details
Declarations are converted to undefined (unless they have a
toCodecJson or toCodec annotation).
Type-level representation returned by
toCodecStringTree
.
toCodecStringTree<function (type parameter) S in toCodecStringTree<S extends Constraint>(schema: S): toCodecStringTree<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 serializerStringTree: anyserializerStringTree(schema: S extends Constraintschema.Constraint["ast"]: SchemaAST.ASTast), { schema: S extends Constraintschema })
}