PropertySignatureA named property within an Objects representation.
Details
name is the property key, which can be a string, number, or symbol.
isOptional indicates whether the key can be absent. isMutable indicates
whether the property is mutable rather than readonly.
modelsObjects
Source effect/SchemaRepresentation.ts:3967 lines
export interface PropertySignature {
readonly PropertySignature.name: PropertyKeyname: type PropertyKey =
| string
| number
| symbol
PropertySignature.type: Representationtype: type Representation =
| Declaration
| Reference
| Suspend
| Null
| Undefined
| Void
| Never
| Unknown
| Any
| String
| Number
| Boolean
| BigInt
| Symbol
| Literal
| UniqueSymbol
| ObjectKeyword
| Enum
| TemplateLiteral
| Arrays
| Objects
| Union
The core tagged union of all supported schema shapes.
Details
Each variant has a _tag discriminator. Switch on _tag to handle each
shape. Most variants carry optional annotations and some carry checks
for validation constraints.
Representation
readonly PropertySignature.isOptional: booleanisOptional: boolean
readonly PropertySignature.isMutable: booleanisMutable: boolean
readonly PropertySignature.annotations?: anyannotations?: import SchemaSchema.declareAnnotations.type Schema.Annotations.Annotations = /*unresolved*/ anyAnnotations | undefined
}Referenced by 2 symbols