module@warp-drive/schema-dsl

Interface ObjectFieldOptions

interface ObjectFieldOptions {
  sourceKey?: string;
  type?: string;
}

Defined in: fields/object.ts:13

Options accepted by the object decorator.

Properties

sourceKey?

sourceKey?: string;

Defined in: fields/object.ts:21

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

---

type?

type?: string;

Defined in: fields/object.ts:30

The name of a Transformation to pass the entire object through before displaying or serializing it. Compiles onto the ObjectField's type.