module@warp-drive/schema-dsl

Decorator attribute()

function attribute(target: object, key: string): void;
function attribute(options: AttributeOptions): (target: object, key: string) => void;

Call Signature

sincev5.9.0

function attribute(target: object, key: string): void;

Defined in: fields/attribute.ts:64

Decorator

CAUTION

This decorator is LEGACY. Prefer field for new schemas; only use this decorator on resources decorated with @Resource({ legacy: true }).

Marks a property as a LegacyAttributeField for use with @warp-drive/legacy/model.

Parameters

target

object

key

string

Returns

void

Example

comment.ts

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

@Resource({ legacy: true })
export class Comment {
  @attribute({ type: 'string' }) declare author: string;
}

compiled fields (excerpt)

[
  { "kind": "attribute", "name": "author", "type": "string" }
]

Call Signature

sincev5.9.0

function attribute(options: AttributeOptions): (target: object, key: string) => void;

Defined in: fields/attribute.ts:65

Decorator

CAUTION

This decorator is LEGACY. Prefer field for new schemas; only use this decorator on resources decorated with @Resource({ legacy: true }).

Marks a property as a LegacyAttributeField for use with @warp-drive/legacy/model.

Parameters

options

AttributeOptions

Returns

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

Example

comment.ts

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

@Resource({ legacy: true })
export class Comment {
  @attribute({ type: 'string' }) declare author: string;
}

compiled fields (excerpt)

[
  { "kind": "attribute", "name": "author", "type": "string" }
]