Socket
Socket
Sign inDemoInstall

keyhole-client

Package Overview
Dependencies
4
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    keyhole-client

A minimal wrapper of the keyhole tracker API


Version published
Weekly downloads
2
Maintainers
1
Install size
437 kB
Created
Weekly downloads
 

Readme

Source

Codecov Coverage CircleCI npm version License: GPL v3

keyhole-client

Just a minimal and slick wrapper of the keyhole API.

Install

npm install keyhole-client

Usage

import createKeyholeClient from 'heyhole-client'

// Create the client using your keyhole access token
const client = createKeyholeClient('my_access_token')

// Create your tracker
const id = await client.createTracker(['soccer', '#fifa'], ['twitter', 'instagram'])

// Pause your tracker
await client.pauseTracker(id)

// Unpause your tracker
await client.startTracker(id)

// List your available trackers
const trackers = await client.getTrackers()

// Get specific tracker
const tracker = await client.getTracker(id)

Errors

  • NotFoundError: Triggered when a tracker is not found
  • NotAuthenticatedError: Triggered when your access token is invalid
  • MissingParameterError: Triggered when the parameters inserted are invalid
  • InternalServerError: Triggered on unspecified errors or due to rate limiting

Typescript

This project is built in typescript and includes TypeScript definitions.

Keywords

FAQs

Last updated on 12 Apr 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc