ObjectSchema
Generated by TypeDoc. Do not edit this page directly.
Class: ObjectSchema<TShape>
Section titled “Class: ObjectSchema<TShape>”Defined in: packages/core/src/schema/index.ts:274
Extends
Section titled “Extends”Schema<ObjectInput<TShape>,ObjectOutput<TShape>>
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
TShape extends ObjectShape |
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ObjectSchema<TShape>(shape): ObjectSchema<TShape>;Defined in: packages/core/src/schema/index.ts:275
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
shape | TShape |
Returns
Section titled “Returns”ObjectSchema<TShape>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”| Property | Modifier | Type | Default value | Inherited from | Defined in |
|---|---|---|---|---|---|
isHarnessSchema | readonly | true | true | Schema.isHarnessSchema | packages/core/src/schema/index.ts:76 |
Methods
Section titled “Methods”default()
Section titled “default()”default(value): DefaultSchema<ObjectInput<TShape> | undefined, ObjectOutput<TShape>>;Defined in: packages/core/src/schema/index.ts:92
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | ObjectOutput<TShape> | (() => ObjectOutput) |
Returns
Section titled “Returns”DefaultSchema<ObjectInput<TShape> | undefined, ObjectOutput<TShape>>
Inherited from
Section titled “Inherited from”describe()
Section titled “describe()”describe(description): this;Defined in: packages/core/src/schema/index.ts:96
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
description | string |
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”optional()
Section titled “optional()”optional(): OptionalSchema<ObjectInput<TShape> | undefined, ObjectOutput<TShape> | undefined>;Defined in: packages/core/src/schema/index.ts:88
Returns
Section titled “Returns”OptionalSchema<ObjectInput<TShape> | undefined, ObjectOutput<TShape> | undefined>
Inherited from
Section titled “Inherited from”parse()
Section titled “parse()”parse(input): ObjectOutput;Defined in: packages/core/src/schema/index.ts:82
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | ObjectInput |
Returns
Section titled “Returns”ObjectOutput
Inherited from
Section titled “Inherited from”safeParse()
Section titled “safeParse()”safeParse(input): SafeParseResult<ObjectOutput<TShape>>;Defined in: packages/core/src/schema/index.ts:279
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”SafeParseResult<ObjectOutput<TShape>>
Overrides
Section titled “Overrides”toJsonSchema()
Section titled “toJsonSchema()”toJsonSchema(): JsonSchema;Defined in: packages/core/src/schema/index.ts:297