omnicar / sam-zip-city

This library aims to do city lookups in a fast (client-side), generic way.

SAM zip-city

This library aims to do city lookups in a fast (client-side), generic way.

The script will dynamically load the appropriate file with zipcodes and city names for a given country.

This allows for smaller bundle size and means that the file(s) are only downloaded when needed.

How to install

npm install @omnicar/sam-zip-city or yarn add @omnicar/sam-zip-city

FAQ

Question:

But are all the zip code files inside the imported package?

Answer: No, only the file(s) with the postal codes (zip codes) of the requested country are retrieved dynamically at run time.

Question:

From where are the file(s) with the postal codes (zip codes) fetched from?

Answer: The postal codes are fetched from admin dot omnicar dot io slash data slash zip-codes slash

---

How to use

import { getCityFromZip } from '@omnicar/sam-zip-city'

const myFunc = async () => {
  const city = await getCityFromZip({
    zipcode: 2300,
    country: 'DK' 
  })
  console.log(city)
}

Or to initialise a country before requesting a city:

import { initZipCityCountry } from '@omnicar/sam-zip-city'

const myOtherFunc = async () => {
  await initZipCityCountry({ country: 'DK' })
  console.log('Danish zipcodes and cities should be ready!')
}

sam-zip-city's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Update dependency node to v10.24.1
• Update dependency tslib to v2

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency @omnicar/sam-types to v0.0.718
• Update dependency @types/jest to v24.9.1
• Update dependency node-fetch to v2.7.0 (node-fetch, @types/node-fetch)
• Update dependency node to v20 (node, @types/node)
• Update dependency node-fetch to v3
• Update dependency typescript to v5
• Update jest monorepo to v29 (major) (@types/jest, jest, ts-jest)
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

circleci

.circleci/config.yml

npm

package.json

• node-fetch ^2.6.11
• tslib ^1.9.3
• @types/node-fetch ^2.6.4
• @omnicar/sam-types 0.0.641
• @types/jest 24.0.11
• @types/node ^11.13.0
• jest ^24.7.0
• ts-jest ^24.0.1
• typescript ^4.1.6

nvm

.nvmrc

• node 10.15.3

---

• Check this box to trigger a request for Renovate to run again on this repository