Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
alertifii-js
Advanced tools
Readme
A Node JS module written in Typescript to use with Alertifii notifications app
This entire library has been rewritten to be based on promises.
The code has been restructured, and the methods changed to make it more complete and versatile.
If you were using a version of the 0.x.x branch, please check the documentation to adapt your code.
npm install --save alertifii-js
Please read the complete documentation in the docs folder
/*
JAVASCRIPT
*/
// Load the module
var Alertifii = require( 'alertifii-js').Alertifii;
// Instance
const alertifii = new Alertifii('integration_id')
// Simple notification (without personalization)
alertifii
.send('My title', 'My message')
.then(console.log)
.catch(console.error)
// Custom notification
alertifii
// Setting the sound
.setSound('cashregister')
// If the priority is 2, you have to provide an expire time and a retry time (see the official API for more info)
.setPriority(2, 60, 30)
// Set an url to access on tap
.setUrl('https://www.github.com/pagertree/alertifii-js', 'Alertifii-JS github')
// Set custom timestamp (must to be unix timestamp, not javascript time!!!)
.setTimestamp(Math.floor(new Date(2020, 2, 1).getTime() / 1000))
// Add a file
.setAttachment('image.jpg', 'path/to/your/file.jpg')
// Mark message as html
.setHtml()
// Send
.send('Submit an issue', 'Click on the link to submit an issue')
.then((msj) => {
console.log(msj)
})
.catch((e) => {
console.error(e)
})
/*
TYPESCRIPT
*/
// Load the module
import { Alertifii } from 'alertifii-js'
// Instance
const alertifii = new Alertifii('integration_id')
// Simple notification (without personalization)
alertifii
.send('My title', 'My message')
.then(console.log)
.catch(console.error)
// Custom notification
alertifii
// Setting the sound
.setSound('cashregister')
// If the priority is 2, you have to provide an expire time and a retry time (see the official API for more info)
.setPriority(2, 60, 30)
// Set an url to access on tap
.setUrl('https://www.github.com/pagertree/alertifii-js', 'Alertifii-JS github')
// Set custom timestamp (must to be unix timestamp, not javascript time!!!)
.setTimestamp(Math.floor(new Date(2020, 2, 1).getTime() / 1000))
// Add a file
.setAttachment('image.jpg', 'path/to/your/file.jpg')
// Mark message as html
.setHtml()
// Send
.send('Submit an issue', 'Click on the link to submit an issue')
.then((msj) => {
console.log(msj)
})
.catch((e) => {
console.error(e)
})
// Load the module
import { Alertifii } from 'alertifii-js'
// Use this inside an async function
const sendNotification = async () => {
// Instance
const alertifii = new Alertifii('integration_id')
// Custom notification
alertifii
// Setting the sound
.setSound('cashregister')
// If the priority is 2, you have to provide an expire time and a retry time (see the official API for more info)
.setPriority(2, 60, 30)
// Add a file
.setAttachment('image.jpg', 'path/to/your/file.jpg')
// Set an url to access on tap
.setUrl('https://www.github.com/pagertree/alertifii-js', 'Alertifii-JS github')
try {
const response = await alertifii.send('Submit an issue', 'Click on the link to submit an issue')
console.log(response)
} catch (error) {
console.error(error)
}
}
For any suggestion or issue, please go to the issues section on the Github repository
FAQs
Library to send notifications with Alertifii
The npm package alertifii-js receives a total of 2 weekly downloads. As such, alertifii-js popularity was classified as not popular.
We found that alertifii-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.