Class AirlineModule

Module to generate airline and airport related data.

Overview

Several methods in this module return objects rather than strings. For example, you can use faker.airline.airport().iataCode to pick out the specific property you need.

For a random airport, use airport().

For a random airline, use airline().

For a dummy booking, a passenger will generally book a flight on a specific flightNumber(), airplane(), be allocated a seat(), and recordLocator().

To generate sample passenger data, you can use the methods of the faker.person module.

Hierarchy (View Summary)

ModuleBase
- AirlineModule

Index

Constructors

constructor

new AirlineModule(faker: Faker): AirlineModule
Parameters
- faker: Faker
Returns AirlineModule
Inherited from ModuleBase.constructor
- Defined in node_modules/.pnpm/@faker-js+faker@9.8.0/node_modules/@faker-js/faker/dist/airline-BUL6NtOJ.d.ts:7262

Properties

`Protected` `Readonly`faker

faker: Faker

Methods

aircraftType

aircraftType(): "narrowbody" | "regional" | "widebody"
Returns a random aircraft type.

Returns "narrowbody" | "regional" | "widebody"
Example
```
faker.airline.aircraftType() // 'narrowbody'
```
Since
8.0.0
- Defined in node_modules/.pnpm/@faker-js+faker@9.8.0/node_modules/@faker-js/faker/dist/airline-BUL6NtOJ.d.ts:7413

airline

airline(): Airline
Generates a random airline.

Returns Airline
Example
```
faker.airline.airline() // { name: 'American Airlines', iataCode: 'AA' }
```
Since
8.0.0
- Defined in node_modules/.pnpm/@faker-js+faker@9.8.0/node_modules/@faker-js/faker/dist/airline-BUL6NtOJ.d.ts:7343

airplane

airplane(): Airplane
Generates a random airplane.

Returns Airplane
Example
```
faker.airline.airplane() // { name: 'Airbus A321neo', iataTypeCode: '32Q' }
```
Since
8.0.0
- Defined in node_modules/.pnpm/@faker-js+faker@9.8.0/node_modules/@faker-js/faker/dist/airline-BUL6NtOJ.d.ts:7352

airport

airport(): Airport
Generates a random airport.

Returns Airport
Example
```
faker.airline.airport() // { name: 'Dallas Fort Worth International Airport', iataCode: 'DFW' }
```
Since
8.0.0
- Defined in node_modules/.pnpm/@faker-js+faker@9.8.0/node_modules/@faker-js/faker/dist/airline-BUL6NtOJ.d.ts:7334

flightNumber

flightNumber(
    options?: {
        addLeadingZeros?: boolean;
        length?: number | { max: number; min: number };
    },
): string
Returns a random flight number. Flight numbers are always 1 to 4 digits long. Sometimes they are used without leading zeros (e.g.: American Airlines flight 425) and sometimes with leading zeros, often with the airline code prepended (e.g.: AA0425).

To generate a flight number prepended with an airline code, combine this function with the airline() function and use template literals:
```
`${faker.airline.airline().iataCode}${faker.airline.flightNumber({ addLeadingZeros: true })}` // 'AA0798'
```
Parameters
- Optionaloptions: { addLeadingZeros?: boolean; length?: number | { max: number; min: number } }
  The options to use.
  - OptionaladdLeadingZeros?: boolean
    Whether to pad the flight number up to 4 digits with leading zeros.
    
    Default
    false
  - Optionallength?: number | { max: number; min: number }
    The number or range of digits to generate.
    
    Default
    { min: 1, max: 4 }
Returns string
Example
```
faker.airline.flightNumber() // '2405'
faker.airline.flightNumber({ addLeadingZeros: true }) // '0249'
faker.airline.flightNumber({ addLeadingZeros: true, length: 2 }) // '0042'
faker.airline.flightNumber({ addLeadingZeros: true, length: { min: 2, max: 3 } }) // '0624'
faker.airline.flightNumber({ length: 3 }) // '425'
faker.airline.flightNumber({ length: { min: 2, max: 3 } }) // '84'
```
Since
8.0.0
- Defined in node_modules/.pnpm/@faker-js+faker@9.8.0/node_modules/@faker-js/faker/dist/airline-BUL6NtOJ.d.ts:7439

recordLocator

recordLocator(
    options?: {
        allowNumerics?: boolean;
        allowVisuallySimilarCharacters?: boolean;
    },
): string
Generates a random record locator. Record locators are used by airlines to identify reservations. They're also known as booking reference numbers, locator codes, confirmation codes, or reservation codes.
Parameters
- Optionaloptions: { allowNumerics?: boolean; allowVisuallySimilarCharacters?: boolean }
  The options to use.
  - OptionalallowNumerics?: boolean
    Whether to allow numeric characters.
    
    Default
    false
  - OptionalallowVisuallySimilarCharacters?: boolean
    Whether to allow visually similar characters such as '1' and 'I'.
    
    Default
    false
Returns string
Example
```
faker.airline.recordLocator() // 'KIFRWE'
faker.airline.recordLocator({ allowNumerics: true }) // 'E5TYEM'
faker.airline.recordLocator({ allowVisuallySimilarCharacters: true }) // 'ANZNEI'
faker.airline.recordLocator({ allowNumerics: true, allowVisuallySimilarCharacters: true }) // '1Z2Z3E'
```
Since
8.0.0
- Defined in node_modules/.pnpm/@faker-js+faker@9.8.0/node_modules/@faker-js/faker/dist/airline-BUL6NtOJ.d.ts:7370

seat

seat(
options?: { aircraftType?: "narrowbody" | "regional" | "widebody" },
): string
Generates a random seat.
Parameters
- Optionaloptions: { aircraftType?: "narrowbody" | "regional" | "widebody" }
  The options to use.
  - OptionalaircraftType?: "narrowbody" | "regional" | "widebody"
    The aircraft type. Can be one of narrowbody, regional, widebody.
    
    Default
    'narrowbody'
Returns string
Example
```
faker.airline.seat() // '22C'
faker.airline.seat({ aircraftType: 'regional' }) // '7A'
faker.airline.seat({ aircraftType: 'widebody' }) // '42K'
```
Since
8.0.0
- Defined in node_modules/.pnpm/@faker-js+faker@9.8.0/node_modules/@faker-js/faker/dist/airline-BUL6NtOJ.d.ts:7397

Class AirlineModule

Overview

Related Modules

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AirlineModule

Properties

Protected Readonlyfaker

Methods

aircraftType

Returns "narrowbody" | "regional" | "widebody"

Example

Since

airline

Returns Airline

Example

Since

airplane

Returns Airplane

Example

Since

airport

Returns Airport

Example

Since

flightNumber

Parameters

OptionaladdLeadingZeros?: boolean

Default

Optionallength?: number | { max: number; min: number }

Default

Returns string

Example

Since

recordLocator

Parameters

OptionalallowNumerics?: boolean

Default

OptionalallowVisuallySimilarCharacters?: boolean

Default

Returns string

Example

Since

seat

Parameters

OptionalaircraftType?: "narrowbody" | "regional" | "widebody"

Default

Returns string

Example

Since

Settings

On This Page

`Protected` `Readonly`faker

`Optional`addLeadingZeros?: boolean

`Optional`length?: number | { max: number; min: number }

`Optional`allowNumerics?: boolean

`Optional`allowVisuallySimilarCharacters?: boolean

`Optional`aircraftType?: "narrowbody" | "regional" | "widebody"