module@warp-drive/schema-dsl

Decorator derived() sincev5.9.0

function derived(options: DerivedOptions): (target: object, key: string) => void;

Defined in: fields/derived.ts:65

Decorator

Marks a property as a DerivedField — a computed, read-only value derived from other fields. Derived fields are never stored in the cache and are never sent to the server.

Parameters

options

DerivedOptions

Returns

(target: object, key: string) => void

Example

user.ts

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

@Resource
export class User {
  @field declare firstName: string;
  @field declare lastName: string;
  @derived({ type: '@concat' }) declare displayName: string;
}

compiled fields (excerpt)

[
  { "kind": "derived", "name": "displayName", "type": "@concat" }
]