Standards Docs
ReferenceSchema

relation

Create a relation attribute builder

Create a relation attribute builder

Signature

<TName extends string>(config: TypedBuilderConfig<TName>): SingleRelationAttributeBuilder<TName, false>

Examples

Single relation (default)
```typescript
relation({ name: "company", label: "Company" })
.to("companies")
.required()

```ts
Multi relation with qualified properties
```typescript
relation({ name: "companies", label: "Companies" })
.to("companies").many()
.qualifyWith(
select({ name: "role", label: "Role" }).options([...]).required(),
number({ name: "shares", label: "Shares" }).min(0),
)

```ts
Polymorphic relation
```typescript
relation({ name: "linked", label: "Linked Items" })
.to("companies")
.to("contacts")
.many()

On this page