module@warp-drive/schema-dsl

Interface AliasOptions

interface AliasOptions {
  kind: string;
  name: string;
  sourceKey?: string;
  type?: string;
}

Defined in: fields/alias.ts:14

Options accepted by the alias decorator, describing the field being aliased.

Properties

kind

kind: string;

Defined in: fields/alias.ts:21

The kind of the field being aliased, e.g. 'field', 'object', or 'array'.

---

name

name: string;

Defined in: fields/alias.ts:28

The name of the field being aliased.

---

sourceKey?

sourceKey?: string;

Defined in: fields/alias.ts:42

The sourceKey of the field being aliased, if it differs from name.

---

type?

type?: string;

Defined in: fields/alias.ts:35

The name of a Transformation associated with the aliased field.