ObjectKeywordType-level representation of ObjectKeyword.
export interface ObjectKeyword extends interface Bottom<out T, out E, out RD, out RE, out Ast extends SchemaAST.AST, out Rebuild extends Top, out TypeMakeIn = T, out Iso = T, in out TypeParameters extends ReadonlyArray<Constraint> = readonly [], out TypeMake = TypeMakeIn, 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">The fully-parameterized base interface for all schemas. Exposes all 14 type
parameters controlling type inference, mutability, optionality, services, and
transformation behavior.
When to use
Use when you are writing advanced generic schema utilities or performing
schema introspection.
Bottom<object, object, never, never, import SchemaASTSchemaAST.class ObjectKeywordclass ObjectKeyword {
_tag: 'ObjectKeyword';
getParser: () => SchemaParser.Parser;
getExpected: () => string;
annotations: Schema.Annotations.Annotations | undefined;
checks: Checks | undefined;
encoding: Encoding | undefined;
context: Context | undefined;
toString: () => string;
}
AST node matching the TypeScript object type — accepts objects, arrays,
and functions (anything non-primitive and non-null).
ObjectKeyword, ObjectKeyword> {}
/**
* Schema for the `object` type. Validates that the input is a non-null object or function
* (i.e. `typeof value === "object" && value !== null || typeof value === "function"`).
*
* @category schemas
* @since 4.0.0
*/
export const const ObjectKeyword: ObjectKeywordconst ObjectKeyword: {
Rebuild: Rebuild;
Iso: Iso;
ast: Ast;
Type: T;
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
annotate: (annotations: Annotations.Bottom<object, readonly []>) => ObjectKeyword;
annotateKey: (annotations: Annotations.Key<object>) => ObjectKeyword;
check: (checks_0: SchemaAST.Check<object>, ...checks: Array<SchemaAST.Check<object>>) => ObjectKeyword;
rebuild: (ast: SchemaAST.ObjectKeyword) => ObjectKeyword;
make: (input: object, options?: MakeOptions) => object;
makeOption: (input: object, options?: MakeOptions) => Option_.Option<object>;
makeEffect: (input: object, options?: MakeOptions) => Effect.Effect<object, 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
ObjectKeyword
.
Schema for the object type. Validates that the input is a non-null object or function
(i.e. typeof value === "object" && value !== null || typeof value === "function").
ObjectKeyword: ObjectKeyword = 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(import SchemaASTSchemaAST.const objectKeyword: SchemaAST.ObjectKeywordconst objectKeyword: {
_tag: 'ObjectKeyword';
getParser: () => SchemaParser.Parser;
getExpected: () => string;
annotations: Schema.Annotations.Annotations | undefined;
checks: Checks | undefined;
encoding: Encoding | undefined;
context: Context | undefined;
toString: () => string;
}
Provides the singleton
ObjectKeyword
AST instance.
When to use
Use to reuse the canonical AST node for the TypeScript object keyword when
building or comparing SchemaAST values directly.
objectKeyword)