Have ideas to improve npm?Join in the discussion! »

    pushover-js

    1.3.1 • Public • Published

    CodeFactor

    pushover-js v1.3.0

    A Node JS module written in Typescript to use with Pushover notifications app


    Breaking changes from v0.x.x

    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.


    Installation

    npm install --save pushover-js

    Documentation

    Please read the complete documentation in the docs folder

    Usage

    Callbacks

    /*
            JAVASCRIPT
    */
    
    // Load the module
    var Pushover = require( 'pushover-js').Pushover;
    
    // Instance
    const pushover = new Pushover('user', 'token')
    
    // Simple notification (without personalization)
    pushover
        .send('My title', 'My message')
            .then(console.log)
            .catch(console.error)
    
    // Custom notification
    pushover
        // 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/danitetus/pushover-js', 'Pushover-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 { Pushover } from 'pushover-js'
    
    // Instance
    const pushover = new Pushover('user', 'token')
    
    // Simple notification (without personalization)
    pushover
        .send('My title', 'My message')
            .then(console.log)
            .catch(console.error)
    
    // Custom notification
    pushover
        // 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/danitetus/pushover-js', 'Pushover-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)
      })

    Async/await

    // Load the module
    import { Pushover } from 'pushover-js'
    
    
    // Use this inside an async function
    const sendNotification = async () => {
        // Instance
        const pushover = new Pushover('user', 'token')
    
        // Custom notification
        pushover
            // 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/danitetus/pushover-js', 'Pushover-JS github')
    
        try {
            const response = await Pushover.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

    Install

    npm i pushover-js

    DownloadsWeekly Downloads

    16

    Version

    1.3.1

    License

    none

    Unpacked Size

    30.2 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar