fiftyone.geolocation
    TypeScript icon, indicating that this package has built-in type declarations

    4.3.4 • Public • Published

    51Degrees Geo-Location Engines

    51Degrees Pipeline API

    Developer Documentation

    Introduction

    This repository contains the geo-location engines for the Node.js implementation of the Pipeline API.

    Pre-requesites

    The Pipeline engines are written in Node.js and target 6 and above.

    Packages

    • 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.

    Installation

    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

    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

    Tests

    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

    Project documentation

    For complete documentation on the Pipeline API and associated engines, see the 51Degrees documentation site.

    Keywords

    none

    Install

    npm i fiftyone.geolocation

    DownloadsWeekly Downloads

    10

    Version

    4.3.4

    License

    EUPL-1.2

    Unpacked Size

    883 kB

    Total Files

    125

    Last publish

    Collaborators

    • 51degrees