module@warp-drive/schema-dsl

Decorator schemaObject() sincev5.9.0

function schemaObject(options): (target, key) => void;

Defined in: fields/schema-object.ts:112

Decorator

Marks a property as a SchemaObjectField — an embedded object whose shape is described by an ObjectSchema.

This is not a relationship. @belongsTo / ResourceField point at another resource by identity. A schema-object is stored inline on the parent and has no identity of its own.

For a bag of primitives with no schema, use object instead.

Parameters

options

SchemaObjectOptions

Returns

(target, key) => void

Example

user.ts

import { Resource, field, schemaObject } from '@warp-drive/schema-dsl';

@Resource
export class User {
  @field declare name: string;
  @schemaObject({ type: 'address' }) declare address: Address;
}

compiled fields (excerpt)

[
  { "kind": "schema-object", "name": "address", "type": "address" }
]