---
title: "ZeyOS.NumFormat"
description: "Base"
canonical_url: "https://www.zeyos.com/zymba/ref/zeyos/zeyos-numformat"
markdown_url: "https://www.zeyos.com/ai/guide/zymba/ref/zeyos/zeyos-numformat.md"
section: "zymba-reference"
authority: "reference"
language: "en"
source_repository: "https://cloud.zeyos.com/__doc/zymbaref.json"
source_sha256: "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915"
---

# ZeyOS.NumFormat

## ZeyOS.NumFormat

```
object @ZeyOS.NumFormat(@Base) {
	construct(string $name) {}
	getFormat(): string {}
	getName(): string {}
	getNumber(): string {}
	incrementCounter(int $offset): int {}
	nextNumber(): string {}
}
```

### Prototype

**[Base](#)**

## Methods


### `$this.construct()`


```code
$this.construct(string $name): void
```

##### Parameters

| Name | Type | Value | Default |
| --- | --- | --- | --- |
| name | `string`  |  | "" |




### `$this.getFormat()`


```code
$this.getFormat(): string
```

##### Returns

| Type | Value |
| --- | ---  |
| `string` |  |




### `$this.getName()`


```code
$this.getName(): string
```

##### Returns

| Type | Value |
| --- | ---  |
| `string` |  |




### `$this.getNumber()`


```code
$this.getNumber(): string
```

##### Returns

| Type | Value |
| --- | ---  |
| `string` |  |




### `$this.incrementCounter()`


```code
$this.incrementCounter(int $offset): int
```

##### Parameters

| Name | Type | Value | Default |
| --- | --- | --- | --- |
| offset | `int`  |  | 1 |

##### Returns

| Type | Value |
| --- | ---  |
| `int` |  |




### `$this.nextNumber()`


```code
$this.nextNumber(): string
```

##### Returns

| Type | Value |
| --- | ---  |
| `string` |  |