Unispec Docs
SDK ReferenceFunctions

defineSchema()

Function: defineSchema()

defineSchema(name, fields, opts?): object

Defined in: packages/sdk/src/backend/records.ts:141

Build a schema definition from field builders — fields are required unless marked .optional():

const Link = defineSchema("link", {
  linkType: f.enum(["todo", "explore-later", "customers-link"]),
  href: f.string(),
  description: f.string().optional(),
}, { embedTemplate: "Saved {linkType} link: {description} ({href})" });
await records.createSchema(Link);

Parameters

name

string

fields

Record<string, FieldBuilder>

opts?

embedTemplate?

string

retention?

RetentionPolicy

Returns

object

embed_template?

optional embed_template?: string

json_schema

json_schema: RecordSchemaDef

name

name: string

retention?

optional retention?: RetentionPolicy

On this page