Nightingale Posing Mischievously

npm

npm’s 2019 JavaScript ecosystem survey analysis is now available! Get your copy here »

trustspot

1.0.3 • Public • Published

trustspot

JavaScript client library for trustspot.io API

Install

npm i -S trustspot

Find your API key

Go to your Account Settings and find the key there.

Create API client instance

import Trustspot from 'trustspot';
 
const trustspot = Trustspot({key: MY_KEY});

Fetch data

getCompanyReviews({limit=10, offset=0, sort='date desc'})

  • limit - number
  • offset - number
  • sort - string, one of: 'date desc', 'rating desc', 'rating asc'
const reviews = await trustspot.getCompanyReviews({offset: 12});
console.log(reviews);

Will print something like this:

{
  error: '',
  company_name: 'Acme Inc',
  review_count: '49',
  average_rating: 4.8,
  limit: 10,
  offset: 12,
  sort: 'date desc',
  company_reviews: [{
    reviewID: '959582',
    fullname: 'Alex Alex',
    rating: '5',
    recommend: '10',
    comments: 'Quick and easy. Great and responsive customer service. They answered any questions I had in a timely manner.',
    date: '2017-10-24',
    response: null,
    response_date: null
  }, {
...SNIP ...
  }, {
    reviewID: '957945',
    fullname: 'Angus Jalex',
    rating: '5',
    recommend: '10',
    comments: 'I\'ve used a lot. Everything just works like you designed it just for yourself.',
    date: '2017-10-10',
    response: 'Thanks Angus for your feedback. We're appreciating your comments and hope to see you again soon.',
    response_date: '2017-10-10'
  }]
}

Changing the baseUrl

If your API is running not on the default domain here is how to use this module against a different URL.

const Trustspot = require('trustspot').compose({properties: {baseUrl: 'localhost:8081'}});
 
const trustspot = Trustspot({key: MY_KEY});

Hardcode the key

If you don't want to pass the API key every time you can set the default API key for all object instances.

const Trustspot = require('trustspot').compose({properties: {key: MY_KEY}});
 
const trustspot = Trustspot(); // No need to pass the key any more!

Contributing

This is an Open Open Source. Whoever submits a meaningful API gets the write access.

Keywords

install

npm i trustspot

Downloadsweekly downloads

12

version

1.0.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability