npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

apialerts-js

v1.0.1

Published

JS wrapper for apialerts.com

Downloads

265

Readme

Magpie - API Alerts

This is a wrapper for the API Alerts service written in JavaScript.

View the API Alerts service at https://apialerts.com. API Alerts is a service that allows you to send simple alerts (push notifications) to your phone or other devices using a simple API.

Installation

You will need to download the Magpie/API Alerts app (created by API Alerts) to use the service. Once you have your API keys from there you can proceed!

Download for IOS: App Store
Download for Android: Play Store

After getting your account setup, install the package using npm.

npm i apialerts-js

We recommend you set the following environment variable. The module will use this to authenticate with the API Alerts service without you having to pass it in every time.

APIALERTS_API_KEY=your_api_key 

Standard Usage

Send a simple message only notification to your devices

import alerts from 'apialerts-js';

alerts.send({ message: 'Hello World' })

Advanced Usage

Specify a different project in a single request

import alerts from 'apialerts-js';

// Pass in the API key as a parameter (Optional)
alerts.send({ message: 'Hello World', api_key: 'your_api_key' })

// Or, set the API key using the setApiKey method before sending the alert
alerts.setApiKey('your_api_key')
alerts.send({ message: 'Hello World' })

Optional Properties

You can optionally supply a list of tags and a link to your simple notification.

let notification = {
  message: 'Hello World',
  tags: ['tag1', 'tag2'],
  link: 'https://apialerts.com',
  api_key: 'your_api_key'
}
alerts.send(notification)

By adding a 'link' property, the app will navigate you to that link when you click on the notification.

Feedback & Support

If you have any questions or feedback, please create an issue on our GitHub repository. We are always looking to improve our service and would love to hear from you. Thanks for using API Alerts!