Skip to content

Sticks/Notifer.JS

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

notifer

A simple libary to interface with an NTFY/our own notification server.

Features

[x] Publish notifications

[] Subcribe to a channel and listen to it's notifications

Usage

Useage is really simple, just import the libary and use the publish function to send a notification to a channel.

const { notifer } = require('@sticksdev/notifer')

const client = new notifer() // A url can also be passed here, if not, it defaults to our instance (notify.hep.gg)
client.REST.publishNotification('channelname', "test message", "Test Notification").then((res) => {
    console.log(res) // Returns an APIBaseResponse or IAPIErrorResponse
})

All options and types are documented in the code, so you can use your IDE to get the types and option. If you have any questions/suggestions/bugs, feel free to open an issue.

About

A library to interact with notify.hep.gg for JS and TS

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published