Interface FieldWith<T>

A field with more said about it: its words (desc), whether a caller may leave it out (optional: then it takes its shape's default, or, for a module, stays out), and whether its values may have no JSON form (opaque, modules only).

interface FieldWith<T = unknown> {
    desc?: string;
    opaque?: boolean;
    optional?: boolean;
    shape: Shape<T> | ZodLike<T> | StandardSchemaLike<T, unknown>;
}

Type Parameters

T = unknown

Index

Properties

desc? opaque? optional? shape

Properties

`Optional` `Readonly`desc

desc?: string

`Optional` `Readonly`opaque

opaque?: boolean

`Optional` `Readonly`optional

optional?: boolean

`Readonly`shape

shape: Shape<T> | ZodLike<T> | StandardSchemaLike<T, unknown>