https://github.com/wisam87/mv-directory
Directory of Atolls, Islands, Banks etc of Maldives
https://github.com/wisam87/mv-directory
atolls islands maldives maldives-atoll maldives-atoll-island maldives-digital-society maldives-island
Last synced: 6 months ago
JSON representation
Directory of Atolls, Islands, Banks etc of Maldives
- Host: GitHub
- URL: https://github.com/wisam87/mv-directory
- Owner: wisam87
- License: mit
- Created: 2020-09-02T18:19:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-12T23:48:17.000Z (over 4 years ago)
- Last Synced: 2025-04-28T20:05:38.239Z (7 months ago)
- Topics: atolls, islands, maldives, maldives-atoll, maldives-atoll-island, maldives-digital-society, maldives-island
- Language: TypeScript
- Homepage:
- Size: 11.3 MB
- Stars: 8
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-maldives - Mv-Directory - Package to fetch / filter Atolls, Islands and Banks of Maldives. (Table of Contents / JAVASCRIPT Projects)
README
# Directory of Maldives Atolls, Islands etc.
[](https://lbesson.mit-license.org/)
Currenty supports:
- All Maldivian Atolls and Islands
- Full Country List.
- All Maldivian Registered Banks.
### Installation
```sh
$ npm install mv-directory
```
## Usage
### Version 2.0 and above.
```javascript
import { Atolls, Islands, Banks, Countries } from "mv-directory";
```
Retreive All / Specific;
- Atolls - All Atolls, Specific Atoll, With Islands.
- All Islands, Specific Island, Inhabited Islands.
- All Banks or Bank by Code
- All Countries or Countries by Name
### Version below 2.0
Import `MvDirectory` in your JavaScript or TypeScript application.
```javascript
import MvDirectory from "mv-directory";
const directory = new MvDirectory();
```
#### Methods
```javascript
// Get All Atolls
directory.getAtolls(withIslands?: boolean, inhabitedIslandsOnly?: boolean);
// Get Specific Atoll
directory.getAtoll(atollCode: string, withIslands?: boolean, inhabitedIslandsOnly?: boolean);
// Islands of a specific Atoll
directory.getAtollIslands(atollCode: string, inhabitedOnly?: boolean);
// Specific Atoll with Islands
directory.getAtollwithIslands(atollCode: string, inhabitedOnly?: boolean);
// Get All Islands
directory.getAllIslands();
// Get specific Island by Name
directory.getIsland(name: string);
// Get list of inhabited Islands
directory.getInhabitedIslands();
// Get list of Countries
directory.getCountries();
// Get country by Code
directory.getCountryByCode(countryCode: string);
// Get country by Name
directory.getCountryByName(name: string);
// Get list of Banks
directory.getBanks();
// Get bank by Code
directory.getBankByCode(bankCode: string);
// Get bank by Name
directory.getBankByName(bankName: string);
```
> Data is up to date as of September 2020.
> Feel free to contribute.
> Whats next? Add Tests