npm promulgates marsupials
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    bossgeopublic

    node-bossgeo

    A node.js wrapper for the Yahoo! BOSS Geo API.

    Installation

    npm install bossgeo
    

    Usage

    First, create a client using your consumer key and consumer secret:

    var BossGeoClient = require('bossgeo').BossGeoClient;
    var bossgeo = new BossGeoClient(
        'consumerKey',
        'consumerSecret'
    );

    Then, you may query the PlaceFinder and PlaceSpotter services as follows:

    bossgeo.placefinder({
        q: '701 first avenue sunnnyvale'
    }, function(err, res) {
        if (err) {
            console.log('error: ' + err);
            return;
        }
     
        console.log(JSON.stringify(res, null, 4));
    });
     
    bossgeo.placespotter({
        documentType: 'text/plain',
        documentContent: 'I live in San Francisco.'
    }, function(err, res) {
        if (err) {
            console.log('error: ' + err);
            return;
        }
     
        console.log(JSON.stringify(res, null, 4));
    });

    More information

    The bossgeo wrapper will force JSON responses from the BOSS Geo API as well as convert numerical errors to human-readable descriptions.

    Placefinder

    Placefinder has two parameter types. Documentation on these arguments can be found at:

    Placespotter

    Placespotter has only one parameter type; docs can be found at:

    Oauth 1.0a implementation

    This wrapper provides its own OAuth 1.0a implementation, which is complete sans access and refresh token fetching.

    License

    MIT

    Keywords

    none

    install

    npm i bossgeo

    Downloadsweekly downloads

    38

    version

    0.0.8

    license

    none

    repository

    githubgithub

    last publish

    collaborators

    • avatar