feat(airline): add airline module

README.md

@@ -78,6 +78,7 @@ The API covers the following modules:
 
 | Module   | Example                                       | Output                                                                                             |
 | -------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| Airline  | `faker.airline.recordLocator()`               | KIFRWE
 | Animal   | `faker.animal.cat()`                          | Norwegian Forest Cat                                                                               |
 | Color    | `faker.color.rgb()`                           | #cdfcdc                                                                                            |
 | Commerce | `faker.commerce.product()`                    | Polo t-shirt                                                                                       |

docs/.vitepress/api-pages.ts

@@ -2,6 +2,7 @@
 // Run 'pnpm run generate:api-docs' to update
 export const apiPages = [
   { text: 'Overview', link: '/api/' },
+  { text: 'Airline', link: '/api/airline.html' },
   { text: 'Animal', link: '/api/animal.html' },
   { text: 'Color', link: '/api/color.html' },
   { text: 'Commerce', link: '/api/commerce.html' },

scripts/generateLocales.ts

@@ -45,6 +45,7 @@ type DefinitionsType = {
  * The types of the definitions.
  */
 const definitionsTypes: DefinitionsType = {
+  airline: 'AirlineDefinitions',
   animal: 'AnimalDefinitions',
   color: 'ColorDefinitions',
   commerce: 'CommerceDefinitions',

src/definitions/airline.ts

@@ -0,0 +1,8 @@
+import type { LocaleEntry } from './definitions';
+
+export type AirlineDefinitions = LocaleEntry<{
+  /**
+   * IATA three-letter airport codes.
+   */
+  airport: string[];
+}>;

src/definitions/definitions.ts

@@ -1,3 +1,4 @@
+import type { AirlineDefinitions } from './airline';
 import type { AnimalDefinitions } from './animal';
 import type { ColorDefinitions } from './color';
 import type { CommerceDefinitions } from './commerce';
@@ -26,6 +27,7 @@ export type LocaleEntry<T> = Partial<T> &
  * The definitions as used by the Faker modules.
  */
 export interface Definitions {
+  airline: AirlineDefinitions;
   animal: AnimalDefinitions;
   color: ColorDefinitions;
   commerce: CommerceDefinitions;

src/definitions/index.ts

@@ -1,3 +1,4 @@
+export type { AirlineDefinitions } from './airline';
 export type { AnimalDefinitions } from './animal';
 export type { ColorDefinitions } from './color';
 export type {

src/faker.ts

@@ -4,6 +4,7 @@ import { deprecated } from './internal/deprecated';
 import type { Mersenne } from './internal/mersenne/mersenne';
 import mersenne from './internal/mersenne/mersenne';
 import type { KnownLocale } from './locales';
+import { AirlineModule } from './modules/airline';
 import { AnimalModule } from './modules/animal';
 import { ColorModule } from './modules/color';
 import { CommerceModule } from './modules/commerce';
@@ -89,6 +90,7 @@ export class Faker {
 
   readonly datatype: DatatypeModule = new DatatypeModule(this);
 
+  readonly airline: AirlineModule = new AirlineModule(this);
   readonly animal: AnimalModule = new AnimalModule(this);
   readonly color: ColorModule = new ColorModule(this);
   readonly commerce: CommerceModule = new CommerceModule(this);

src/index.ts

@@ -2,6 +2,7 @@ import { Faker } from './faker';
 import allLocales from './locales';
 
 export type {
+  AirlineDefinitions,
   AnimalDefinitions,
   ColorDefinitions,
   CommerceDefinitions,
@@ -35,6 +36,8 @@ export type {
 } from './definitions';
 export { FakerError } from './errors/faker-error';
 export type { FakerOptions, UsableLocale, UsedLocales } from './faker';
+export { Aircraft, AircraftType } from './modules/airline';
+export type { AirlineModule } from './modules/airline';
 export type { AnimalModule } from './modules/animal';
 export type {
   Casing,