Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 56 additions & 10 deletions docs-src/docs/040-test-data/domain/020-airline.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,45 @@ Returns a random flight number. Flight numbers are always 1 to 4 digits long and
- Canonical: `awd.domain.airline.flightNumber`
- Faker docs: [https://fakerjs.dev/api/airline](https://fakerjs.dev/api/airline)

No parameters.
| Arg | Type | Required | Description |
| --- | --- | --- | --- |
| `length` | `number` | no | Desired flight-number length. |
| `addLeadingZeros` | `boolean` | no | Whether shorter flight numbers should be padded with leading zeros. |

Examples:

Shows the default airline.flightNumber call.

```txt
airline.flightNumber
airline.flightNumber()
```

Returns: `70`

Shows airline.flightNumber using length and leading-zero options.

```txt
airline.flightNumber(length=4, addLeadingZeros=true)
```

Returns: `4703`

Shows airline.flightNumber using a fixed length.

```txt
airline.flightNumber(length=4)
```

Returns: `4703`

Shows airline.flightNumber padding shorter values with leading zeros.

```txt
airline.flightNumber(addLeadingZeros=true)
```

Returns: `0070`

### `airline.iataCode`

Generate an airline IATA code.
Expand All @@ -66,7 +93,7 @@ Examples:
Shows the default airline.airline.iataCode call.

```txt
airline.airline.iataCode
airline.iataCode
```

Returns: `FZ`
Expand All @@ -85,7 +112,7 @@ Examples:
Shows the default airline.airline.name call.

```txt
airline.airline.name
airline.name
```

Returns: `Flydubai`
Expand All @@ -97,18 +124,37 @@ Generates a random record locator. Record locators are 6-character alphanumeric
- Canonical: `awd.domain.airline.recordLocator`
- Faker docs: [https://fakerjs.dev/api/airline](https://fakerjs.dev/api/airline)

No parameters.
| Arg | Type | Required | Description |
| --- | --- | --- | --- |
| `allowNumerics` | `boolean` | no | Whether numeric characters can be included. |
| `allowVisuallySimilarCharacters` | `boolean` | no | Whether visually similar characters such as I, 1, O, and 0 can be included. |

Examples:

Shows the default airline.recordLocator call.

```txt
airline.recordLocator
airline.recordLocator()
```

Returns: `KTAGDC`

Shows airline.recordLocator allowing numeric characters.

```txt
airline.recordLocator(allowNumerics=true)
```

Returns: `ER2B64`

Shows airline.recordLocator allowing visually similar characters.

```txt
airline.recordLocator(allowVisuallySimilarCharacters=true)
```

Returns: `KSAHDC`

### `airline.seat`

Generates a random seat.
Expand Down Expand Up @@ -160,7 +206,7 @@ Examples:
Shows the default airline.airplane.iataTypeCode call.

```txt
airline.airplane.iataTypeCode
airplane.iataTypeCode
```

Returns: `74J`
Expand All @@ -179,7 +225,7 @@ Examples:
Shows the default airline.airplane.name call.

```txt
airline.airplane.name
airplane.name
```

Returns: `Boeing 747-400D`
Expand All @@ -198,7 +244,7 @@ Examples:
Shows the default airline.airport.iataCode call.

```txt
airline.airport.iataCode
airport.iataCode
```

Returns: `HRG`
Expand All @@ -217,7 +263,7 @@ Examples:
Shows the default airline.airport.name call.

```txt
airline.airport.name
airport.name
```

Returns: `Hurgada International Airport`
68 changes: 62 additions & 6 deletions docs-src/docs/040-test-data/domain/140-git.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,33 +40,79 @@ Generates a date string for a git commit using the same format as `git log`.
- Canonical: `awd.domain.git.commitDate`
- Faker docs: [https://fakerjs.dev/api/git](https://fakerjs.dev/api/git)

No parameters.
| Arg | Type | Required | Description |
| --- | --- | --- | --- |
| `refDate` | `string\|date\|number` | no | The date to use as reference point for generated commit dates. |

Examples:

Shows the default git.commitDate call.

```txt
git.commitDate
git.commitDate()
```

Returns: `Thu Jun 18 01:55:50 2026 +0600`

Shows git.commitDate using a reference date.

```txt
git.commitDate(refDate="2024-01-01T00:00:00.000Z")
```

Returns: `Sun Dec 31 10:00:30 2023 +0600`

### `git.commitEntry`

Generates a random commit entry as printed by `git log`.

- Canonical: `awd.domain.git.commitEntry`
- Faker docs: [https://fakerjs.dev/api/git](https://fakerjs.dev/api/git)

No parameters.
| Arg | Type | Required | Description |
| --- | --- | --- | --- |
| `merge` | `boolean` | no | Whether to generate a merge commit entry. |
| `eol` | `LF\|CRLF` | no | Line ending to use in the generated commit entry. |
| `refDate` | `string\|date\|number` | no | The date to use as reference point for generated commit dates. |

Examples:

Shows the default git.commitEntry call.

```txt
git.commitEntry
git.commitEntry()
```

Returns: `commit f0632478b9f4d0e9c34bf6fdd103d29fbf6fc0af\nAuthor: Ricardo Upton <Ricardo.Upton@gmail.com>\nDate: Wed Jun 17 19:26:37 2026 +0300\n\n    parse auxiliary feed\n`

Shows git.commitEntry using merge and line-ending options.

```txt
git.commitEntry(merge=true, eol="LF")
```

Returns: `commit 9f0632478b9f4d0e9c34bf6fdd103d29fbf6fc0a\nMerge: fa6b29d 6620e45\nAuthor: Lindsey_Price41 <Lindsey_Price@hotmail.com>\nDate: Thu Jun 18 13:36:13 2026 -0800\n\n    calculate redundant feed\n`

Shows git.commitEntry using a reference date.

```txt
git.commitEntry(refDate="2024-01-01T00:00:00.000Z")
```

Returns: `commit f0632478b9f4d0e9c34bf6fdd103d29fbf6fc0af\nAuthor: Ricardo Upton <Ricardo.Upton@gmail.com>\nDate: Sun Dec 31 03:31:17 2023 +0300\n\n    parse auxiliary feed\n`

Shows git.commitEntry forcing a merge commit entry.

```txt
git.commitEntry(merge=true)
```

Returns: `commit 9f0632478b9f4d0e9c34bf6fdd103d29fbf6fc0a\nMerge: fa6b29d 6620e45\nAuthor: Lindsey_Price41 <Lindsey_Price@hotmail.com>\nDate: Thu Jun 18 13:36:13 2026 -0800\n\n    calculate redundant feed\n`

Shows git.commitEntry using LF line endings.

```txt
git.commitEntry(eol="LF")
```

Returns: `commit f0632478b9f4d0e9c34bf6fdd103d29fbf6fc0af\nAuthor: Ricardo Upton <Ricardo.Upton@gmail.com>\nDate: Wed Jun 17 19:26:37 2026 +0300\n\n    parse auxiliary feed\n`
Expand Down Expand Up @@ -97,14 +143,24 @@ Generates a random commit sha.
- Canonical: `awd.domain.git.commitSha`
- Faker docs: [https://fakerjs.dev/api/git](https://fakerjs.dev/api/git)

No parameters.
| Arg | Type | Required | Description |
| --- | --- | --- | --- |
| `length` | `number` | no | The length of the generated commit SHA. |

Examples:

Shows the default git.commitSha call.

```txt
git.commitSha
git.commitSha()
```

Returns: `9f0632478b9f4d0e9c34bf6fdd103d29fbf6fc0a`

Shows git.commitSha using a shorter SHA length.

```txt
git.commitSha(length=7)
```

Returns: `9f06324`
Loading