nz-postage-regions
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

NZ Postage Regions

A handy tool for matching post codes with regions in New Zealand. This tool groups post codes into regions that can be used for things like calculating shipping/postage costs etc.

A common use-case is having postage costs stored in a database/CMS for each of the regions. Then depending on a customers post code we can determine what region and cost.

Installation

npm install nz-postage-regions
yarn add nz-postage-regions

Usage

import { getRegion } from 'nz-postage-regions';

const postageRegion = getRegion(postalCode);

Regions

  • Rural

    • northIslandRural
    • southIslandRural
  • Non Rural

    • northland
    • auckland
    • waikato
    • gisborneHawkesBay
    • bayOfPlenty
    • taranakiManawatuWhanganui
    • wellington
    • nelsonMarlboroughTasman
    • canterburyWestCoast
    • otago

License

ISC

Readme

Keywords

none

Package Sidebar

Install

npm i nz-postage-regions

Weekly Downloads

0

Version

1.0.1

License

ISC

Unpacked Size

20.1 kB

Total Files

4

Last publish

Collaborators

  • balancesoftware