Function: makeObjectSchema()¶

makeObjectSchema<K, L, T>(schemaDef): T & object

Defined in: schema.ts:2011

A wrapper for creating a schema definition for an object value.

It is always recommended to use wrapper functions for creating top-level schema objects rather than specifying object literals. Wrappers validate your schemas at creation time, provide better TypeScript type inference, and can reduce boilerplate.

Example¶

coda.makeObjectSchema({
  id: "email",
  primary: "name",
  properties: {
    email: {type: coda.ValueType.String, required: true},
    name: {type: coda.ValueType.String, required: true},
  },
});

Type Parameters¶

Type Parameter
`K` extends `string`
`L` extends `string`
`T` extends `Omit`<`ObjectSchemaDefinition`<`K`, `L`>, `"type"`> & `ObjectSchemaProperty`

Parameters¶

Parameter	Type
`schemaDef`	`Exact`<`T`, `Omit`<`ObjectSchemaDefinition`<`K`, `L`>, `"type"`> & `ObjectSchemaProperty` & `object`>

Returns¶

T & object