---
url: https://canary.warp-drive.io/api/@warp-drive/schema-dsl/functions/alias.md
description: >-
  Property decorator that compiles to an alias field, which reads from another
  field in the same schema and can write back to it in editable modes.
---

#  alias() 

```ts
function alias(options: AliasOptions): (target: object, key: string) => void;
```

Defined in: [fields/alias.ts:82](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/schema-dsl/src/fields/alias.ts#L82)

**`Decorator`**

Marks a property as an alias — compiling to a
[LegacyAliasField](../../core/types/schema/fields/types/LegacyAliasField.md), [PolarisAliasField](../../core/types/schema/fields/types/PolarisAliasField.md), or
[ObjectAliasField](../../core/types/schema/fields/types/ObjectAliasField.md) depending on the schema it's declared on
— that points to another field already present in the schema.

Unlike [derived](derived.md), an alias may write back to its source field when
the record is in an editable mode.

## Parameters

### options

[`AliasOptions`](../types/AliasOptions.md)

## Returns

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

## Example

::: code-group

```ts [product.ts]
import { Resource, field, alias } from '@warp-drive/schema-dsl';

@Resource
export class Product {
  @field({ sourceKey: 'product_name' }) declare name: string;
  @alias({ kind: 'field', name: 'name' }) declare productName: string;
}
```

```json [compiled fields (excerpt)]
[
  { "kind": "field", "name": "name", "sourceKey": "product_name" },
  { "kind": "alias", "name": "productName", "type": null, "options": { "kind": "field", "name": "name" } }
]
```

:::