# Amount

## Extends

- `Amount`

### abs()

```ts
abs(): Amount;
```

Returns an absolute Amount.

#### Returns

`Amount`

#### Inherited from

```ts
Bkper.Amount.abs
```

***

### cmp()

```ts
cmp(n): -1 | 0 | 1;
```

Compare

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`-1` \| `0` \| `1`

#### Inherited from

```ts
Bkper.Amount.cmp
```

***

### div()

```ts
div(n): Amount;
```

Divide by

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`Amount`

#### Inherited from

```ts
Bkper.Amount.div
```

***

### eq()

```ts
eq(n): boolean;
```

Equals to

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`boolean`

#### Inherited from

```ts
Bkper.Amount.eq
```

***

### gt()

```ts
gt(n): boolean;
```

Greater than

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`boolean`

#### Inherited from

```ts
Bkper.Amount.gt
```

***

### gte()

```ts
gte(n): boolean;
```

Greater than or equal

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`boolean`

#### Inherited from

```ts
Bkper.Amount.gte
```

***

### lt()

```ts
lt(n): boolean;
```

Less than

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`boolean`

#### Inherited from

```ts
Bkper.Amount.lt
```

***

### lte()

```ts
lte(n): boolean;
```

Less than or equal to

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`boolean`

#### Inherited from

```ts
Bkper.Amount.lte
```

***

### minus()

```ts
minus(n): Amount;
```

Minus

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`Amount`

#### Inherited from

```ts
Bkper.Amount.minus
```

***

### mod()

```ts
mod(n): Amount;
```

Modulo - the integer remainder of dividing this Amount by n.

Similar to % operator

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`Amount`

#### Inherited from

```ts
Bkper.Amount.mod
```

***

### plus()

```ts
plus(n): Amount;
```

Sum

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`Amount`

#### Inherited from

```ts
Bkper.Amount.plus
```

***

### round()

```ts
round(dp?): Amount;
```

Round to a maximum of dp decimal places.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `dp?` | `number` |

#### Returns

`Amount`

#### Inherited from

```ts
Bkper.Amount.round
```

***

### times()

```ts
times(n): Amount;
```

Multiply

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `n` | `string` \| `number` \| `Amount` |

#### Returns

`Amount`

#### Inherited from

```ts
Bkper.Amount.times
```

***

### toFixed()

```ts
toFixed(dp?): string;
```

Returns a string representing the value of this Amount in normal notation to a fixed number of decimal places dp.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `dp?` | `number` |

#### Returns

`string`

#### Inherited from

```ts
Bkper.Amount.toFixed
```

***

### toNumber()

```ts
toNumber(): number;
```

Returns a primitive number representing the value of this Amount.

#### Returns

`number`

#### Inherited from

```ts
Bkper.Amount.toNumber
```

***

### toString()

```ts
toString(): string;
```

Returns a string representing the value of this Amount.

#### Returns

`string`

#### Inherited from

```ts
Bkper.Amount.toString
```