ObjectsAn object/struct type with named properties and optional index signatures.
Details
propertySignatures are the explicitly named fields. indexSignatures
define catch-all key/value types, such as Record<string, T>. checks
holds object-specific constraints, such as minProperties and maxProperties.
export interface Objects {
readonly Objects._tag: "Objects"_tag: "Objects"
readonly Objects.annotations?: Schema.Annotations.Annotations | undefinedannotations?: import SchemaSchema.Annotations.interface Annotations.AnnotationsThis interface is used to define the annotations that can be attached to a
schema. You can extend this interface to define your own annotations.
Details
Note that both a missing key or undefined is used to indicate that the
annotation is not present.
This means that can remove any annotation by setting it to undefined.
Example (Defining your own annotations)
import { Schema } from "effect"
// Extend the Annotations interface with a custom `version` annotation
declare module "effect/Schema" {
namespace Annotations {
interface Annotations {
readonly version?:
| readonly [major: number, minor: number, patch: number]
| undefined
}
}
}
// The `version` annotation is now recognized by the TypeScript compiler
const schema = Schema.String.annotate({ version: [1, 2, 0] })
// const version: readonly [major: number, minor: number, patch: number] | undefined
const version = Schema.resolveAnnotations(schema)?.["version"]
if (version) {
// Access individual parts of the version
console.log(version[1])
// Output: 2
}
Annotations | undefined
readonly Objects.propertySignatures: ReadonlyArray<PropertySignature>propertySignatures: interface ReadonlyArray<T>ReadonlyArray<PropertySignature>
readonly Objects.indexSignatures: ReadonlyArray<IndexSignature>indexSignatures: interface ReadonlyArray<T>ReadonlyArray<IndexSignature>
readonly Objects.checks: ReadonlyArray<Check<ObjectsMeta>>checks: interface ReadonlyArray<T>ReadonlyArray<type Check<M> = Filter<M> | FilterGroup<M>A validation constraint attached to a type. Either a single
Filter
or a
FilterGroup
combining multiple checks.
Check<type ObjectsMeta =
| {
readonly _tag: "isMinProperties"
readonly minProperties: number
}
| {
readonly _tag: "isMaxProperties"
readonly maxProperties: number
}
| {
readonly _tag: "isPropertiesLengthBetween"
readonly minimum: number
readonly maximum: number
}
| {
readonly _tag: "isPropertyNames"
readonly propertyNames: Representation
}
Metadata union for object-specific validation checks (minProperties,
maxProperties, propertiesLength, propertyNames).
ObjectsMeta>>
}