diff options
| author | Matt Mayer <[email protected]> | 2023-03-29 20:36:46 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-29 13:36:46 +0000 |
| commit | 3562e872530b3610d95be71aa6f4f7fdfef7134f (patch) | |
| tree | c6ba28a9f3cf30e5bf5c0a935fead6bdb2668531 /src/modules/airline | |
| parent | 88e561a5490003a41665eb007c5c28ff0800ae09 (diff) | |
| download | faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.tar.xz faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.zip | |
docs: add overview guides to specific modules (#1929)
Diffstat (limited to 'src/modules/airline')
| -rw-r--r-- | src/modules/airline/index.ts | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/src/modules/airline/index.ts b/src/modules/airline/index.ts index 14653bc8..a9432dc6 100644 --- a/src/modules/airline/index.ts +++ b/src/modules/airline/index.ts @@ -61,7 +61,21 @@ const aircraftTypeSeats: Record<AircraftType, string[]> = { }; /** - * Module to generate airline related data. + * 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()`](https://next.fakerjs.dev/api/airline.html#airport). + * + * For a random airline, use [`airline()`](https://next.fakerjs.dev/api/airline.html#airline). + * + * For a dummy booking, a passenger will generally book a flight on a specific [`flightNumber()`](https://next.fakerjs.dev/api/airline.html#flightnumber), [`airplane()`](https://next.fakerjs.dev/api/airline.html#airplane), be allocated a [`seat()`](https://next.fakerjs.dev/api/airline.html#seat), and [`recordLocator()`](https://next.fakerjs.dev/api/airline.html#recordlocator). + * + * ### Related Modules + * + * - To generate sample passenger data, you can use the methods of the [`faker.person`](https://next.fakerjs.dev/api/person.html) module. */ export class AirlineModule { constructor(private readonly faker: Faker) { |
