-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[misc] add licence and readme to the published package
- Loading branch information
Showing
3 changed files
with
162 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2023 2BAD | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # Ryanair API | ||
|
|
||
| [](https://www.npmjs.com/package/@2bad/ryanair) | ||
| [](https://www.npmjs.com/package/@2bad/ryanair) | ||
| [](https://github.com/2BAD/ryanair/actions/workflows/build.yml) | ||
| [](https://codecov.io/gh/2BAD/ryanair) | ||
| [](https://github.com/2BAD/ryanair/search?l=typescript) | ||
| [](https://www.postman.com/hakkotsu/workspace/ryanair) | ||
|
|
||
| Unofficial TypeScript client for Ryanair's API that provides easy access to flights, fares, and airport information. | ||
|
|
||
| ## Install | ||
|
|
||
| ```shell | ||
| npm install @2bad/ryanair | ||
| ``` | ||
|
|
||
| **Warning:** This package is native [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) and no longer provides a CommonJS export. If your project uses CommonJS, you will have to [convert to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) or use the [dynamic `import()`](https://v8.dev/features/dynamic-import) function. Please don't open issues for questions regarding CommonJS / ESM. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```typescript | ||
| import { airports, fares, flights } from '@2bad/ryanair' | ||
|
|
||
| // Find your nearest airport | ||
| const closest = await airports.getClosest() | ||
|
|
||
| // Check available flight dates | ||
| const dates = await flights.getDates('BER', 'DUB') | ||
|
|
||
| // Get cheapest fares for your trip | ||
| const deals = await fares.getCheapestPerDay('BER', 'DUB', '2024-02-01') | ||
| ``` | ||
|
|
||
| ## API Overview | ||
|
|
||
| ### Airports API | ||
| - Get active airports list | ||
| - Find nearest airports | ||
| - Discover available destinations | ||
| - View airport details | ||
| - Search flight routes | ||
|
|
||
| [View Airports Documentation →](docs/airports.md) | ||
|
|
||
| ### Fares API | ||
| - Find cheapest daily fares | ||
| - Compare prices across date ranges | ||
| - Discover best round-trip deals | ||
| - Search by currency preference | ||
|
|
||
| [View Fares Documentation →](docs/fares.md) | ||
|
|
||
| ### Flights API | ||
| - Check flight availability | ||
| - View flight schedules | ||
| - Search available dates | ||
| - Access flight details | ||
|
|
||
| [View Flights Documentation →](docs/flights.md) | ||
|
|
||
| ## Understanding IATA Codes | ||
|
|
||
| IATA codes are three-letter identifiers used in aviation for airports worldwide. For example: | ||
| - `DUB` - Dublin Airport | ||
| - `BER` - Berlin Brandenburg Airport | ||
| - `STN` - London Stansted Airport | ||
|
|
||
| Find the complete list on [IATA's official website](https://www.iata.org/en/publications/directories/code-search/). | ||
|
|
||
| ## Disclaimer | ||
|
|
||
| This is an unofficial package and is not affiliated with Ryanair. Usage is subject to Ryanair's API terms and conditions. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are welcome! Here's how you can help: | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a feature branch | ||
| 3. Submit a pull request | ||
|
|
||
| Please ensure your code passes all tests and follows our coding standards. | ||
|
|
||
| ## License | ||
|
|
||
| MIT © [2BAD](https://github.com/2BAD) | ||
|
|
||
| --- | ||
|
|
||
| Need help? [Open an issue](https://github.com/2BAD/ryanair/issues) or check our [Postman collection](https://www.postman.com/hakkotsu/workspace/ryanair). |