Nimble Pixie Merchant

    malaysia-postcodes

    1.0.5 • Public • Published

    Malaysia Postcodes

    List of Malaysia Postcodes with City and State (JSON)

    Table of Contents

    Installation

    Install the package from NPM.

    npm i malaysia-postcodes

    Include it in your script.

    import {
      allPostcodes,
      getStates,
      getCities,
      getPostcodes,
      findPostcode
    } from "malaysia-postcodes";

    Usage

    allPostcodes

    Return all postcodes data with city and state

    Example usage

    const postcodes = allPostcodes;

    Example results

    [
        {
          "name": "Kelantan",
          "city": [
            {
              "name": "Pasir Mas",
              "postcode": [
                "17000",
                "17007",
                "17009",
                "17010",
                "17020",
                "17030",
                "17040",
                "17050",
                "17060",
                "17070"
              ]
            },
            ...
          ]
        },
        ...
    ]

    getStates

    Return all states data

    Example usage

    const states = getStates();

    Example results

    [
      "Wp Kuala Lumpur",
      "Johor",
      "Kedah",
      "Kelantan",
      "Melaka",
      "Negeri Sembilan",
      "Pahang",
      "Penang",
      "Perak",
      "Perlis",
      "Sabah",
      "Sarawak",
      "Selangor",
      "Terengganu",
      "Wp Labuan",
      "Wp Putrajaya"
    ];

    getCities

    Return all cities data based on selected state

    Example usage

    const cities = getCities("Kelantan");

    Example results

    [
      "Ayer Lanas",
      "Bachok",
      "Cherang Ruku",
      "Dabong",
      "Gua Musang",
      "Jeli",
      "Kem Desa Pahlawan",
      "Ketereh",
      "Kota Bharu",
      "Kuala Balah",
      "Kuala Krai",
      "Machang",
      "Melor",
      "Pasir Mas",
      "Pasir Puteh",
      "Pulai Chondong",
      "Rantau Panjang",
      "Selising",
      "Tanah Merah",
      "Temangan",
      "Tumpat",
      "Wakaf Bharu"
    ];

    getPostcodes

    Return all postcodes data based on selected state and city

    Example usage

    const postcodes = getPostcodes("Kelantan", "Pasir Mas");

    Example results

    [
      "17000",
      "17007",
      "17009",
      "17010",
      "17020",
      "17030",
      "17040",
      "17050",
      "17060",
      "17070"
    ];

    findPostcode

    Return state and city data based on postcode

    Example usage

    const location = findPostcode("17070");

    Example result if postcode found

    {
      "found": true,
      "state": "Kelantan",
      "city": "Pasir Mas"
    }

    Example result if postcode not found

    {
      "found": false
    }

    Contributing

    If you spot any errors, typos or missing information, please submit a pull request.

    License

    MIT. See LICENSE for more details.

    Install

    npm i malaysia-postcodes

    DownloadsWeekly Downloads

    62

    Version

    1.0.5

    License

    ISC

    Unpacked Size

    45.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • asyrafhussin