Important
This repo has been merged into the monorepo https://github.com/51Degrees/51degrees-node, under location/. Please refer to the new monorepository for issues and PRs. The npm package fiftyone.geolocation keeps its name and is published from there, from version 4.5.98.
This repository contains the geo-location engines for the Node.js implementation of the Pipeline API.
The Pipeline engines are written in Node.js and target 6 and above.
- geoLocationCloud - A Node.js engine which retrieves geo-location results by consuming data from the 51Degrees cloud service.
- geoLocationPipelineBuilder - Contains the geo-location engine builders.
You can either reference the projects in this repository or you can reference the NPM packages in your project:
npm install fiftyone.geolocation
Make sure to select the latest version from NPM.
Examples can be found in the examples/ folder. See below for a list of examples.
| Example | Description | Implemtation |
|---|---|---|
| gettingStarted.js | This example uses geo-location to determine the country from a longitude and latitude. | Cloud |
| combiningServices.js | This example uses geo-location alongside device detection to determine the country and device. | Cloud |
| configureFromFile.js | This example shows how to configure pipeline with geo-location from a configuration file. | Cloud |
| webIntegration.js | This example demonstrates how to get location information from the device that a user is using to access a website. | Cloud |
In this repository, there are tests for the examples. You will need to install jest to run them:
npm install jest --global
To run the tests, then call:
jest
For complete documentation on the Pipeline API and associated engines, see the 51Degrees documentation site.