Code Monkey home page Code Monkey logo

mv-directory's Introduction

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

mv-directory's People

Contributors

ihumaid avatar wisam87 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

mv-directory's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.