Skip to content
module@warp-drive/schema-dsl

Interface FieldOptions ​

ts
interface FieldOptions {
  sourceKey?: string;
  type?: string;
}

Defined in: fields/field.ts:12

Options accepted by the field decorator.

Properties ​

sourceKey? ​

ts
sourceKey?: string;

Defined in: fields/field.ts:26

The name of the field as returned by the API, if it differs from the decorated property's name. Compiles onto the field's sourceKey.


type? ​

ts
type?: string;

Defined in: fields/field.ts:18

The name of a Transformation to compile onto the field's type.

Released under the MIT License.