[go: up one dir, main page]

Skip to content

Directory of Atolls, Islands, Banks etc of Maldives

License

Notifications You must be signed in to change notification settings

wisam87/mv-directory

Repository files navigation

Directory of Maldives Atolls, Islands etc.

MIT license npm

Currenty supports:

  • All Maldivian Atolls and Islands
  • Full Country List.
  • All Maldivian Registered Banks.

Installation

$ npm install mv-directory

Usage

Version 2.0 and above.

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.

import MvDirectory from "mv-directory";
const directory = new MvDirectory();

Methods

// 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