https://github.com/ahzhezhe/onemapsg

Helper library for using OneMap APIs
https://github.com/ahzhezhe/onemapsg

onemap

Last synced: about 1 month ago
JSON representation

Helper library for using OneMap APIs

• Host: GitHub
• URL: https://github.com/ahzhezhe/onemapsg
• Owner: ahzhezhe
• License: isc
• Created: 2020-05-02T13:02:51.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T15:54:51.000Z (6 months ago)
• Last Synced: 2024-10-31T20:05:47.250Z (about 2 months ago)
• Topics: onemap
• Language: TypeScript
• Homepage:
• Size: 2.9 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# **onemapsg**

[![npm package](https://img.shields.io/npm/v/onemapsg)](https://www.npmjs.com/package/onemapsg)

[![npm downloads](https://img.shields.io/npm/dt/onemapsg)](https://www.npmjs.com/package/onemapsg)

[![GitHub issues](https://img.shields.io/github/issues/ahzhezhe/onemapsg)](https://github.com/ahzhezhe/onemapsg/issues)

[![GitHub license](https://img.shields.io/github/license/ahzhezhe/onemapsg)](https://github.com/ahzhezhe/onemapsg/blob/master/LICENSE)

Helper library for using OneMap APIs (https://docs.onemap.sg/).

## **Install via NPM**

```

npm install onemapsg

```

## **Usage**

```typescript

import OneMap from 'onemapsg';

// Credential is optional, you do not need to supply credential if you are using common APIs only.

const onemap = new OneMap({

  email: 'your_email',

  password: 'your_password'

});

const result = await onemap.search.search({

  searchVal: '542226',

  returnGeom: true,

  getAddrDetails: true

});

```