@aschenoni/jargon

# @aschenoni/jargon

## Table of contents

### Classes

- [default](classes/default.md)

### Functions

- [alias](README.md#alias)
- [option](README.md#option)
- [positional](README.md#positional)
- [required](README.md#required)

## Functions

### alias

▸ **alias**(...`aliases`: *string*[]): (`target`: [*default*](classes/default.md), `key`: *string*) => *void*

#### Parameters:

Name | Type |
:------ | :------ |
`...aliases` | *string*[] |

**Returns:** *function*

Defined in: [decorators/alias.ts:3](https://github.com/aschenoni/jargon/blob/814b89d/src/decorators/alias.ts#L3)

___

### option

▸ **option**(`target`: [*default*](classes/default.md), `key`: *string*): *void*

#### Parameters:

Name | Type |
:------ | :------ |
`target` | [*default*](classes/default.md) |
`key` | *string* |

**Returns:** *void*

Defined in: [decorators/option.ts:3](https://github.com/aschenoni/jargon/blob/814b89d/src/decorators/option.ts#L3)

___

### positional

▸ **positional**(`target`: [*default*](classes/default.md), `key`: *string*): *void*

#### Parameters:

Name | Type |
:------ | :------ |
`target` | [*default*](classes/default.md) |
`key` | *string* |

**Returns:** *void*

Defined in: [decorators/positional.ts:3](https://github.com/aschenoni/jargon/blob/814b89d/src/decorators/positional.ts#L3)

___

### required

▸ **required**(`target`: [*default*](classes/default.md), `key`: *string*): *void*

#### Parameters:

Name | Type |
:------ | :------ |
`target` | [*default*](classes/default.md) |
`key` | *string* |

**Returns:** *void*

Defined in: [decorators/required.ts:3](https://github.com/aschenoni/jargon/blob/814b89d/src/decorators/required.ts#L3)