Nascent Prototype Metaverse
    Wondering what’s next for npm?Check out our public roadmap! »

    sos

    2.0.0 • Public • Published

    sos MIT License Issues PR's Welcome Stars

    SOS

    Worldwide Emergency Services Numbers, with self-updater.

    Installing

    npm install sos
    

    Usage

    const sos = require('sos');
     
    // .countryInfo('ISO_code') gives you details about the country
    console.log('About the USA', sos.countryInfo('US'));
     
    // .isMemberOf112('ISO_code') true if the country is part 
    // of the 112 emergency number group
    console.log('Is Morocco a member of the 112 group', sos.isMemberOf112('MA'));
     
    // .isLocalOnly('ISO_code') true if you can call their 
    // emergency numbers internationally
    console.log('Can you call US emergency numbers internationally', sos.isLocalOnly('US'));

    to get emegergency numbers of a country:

    sos.police('ISO_code')
    sos.ambulance('ISO_code')
    sos.fire('ISO_code')
    sos.dispatch('ISO_code')

    Each returns an array of emergency numbers, each is an object:

    exp: { "type": "All", "value": "911" }

    type can be:

    • "All": you can call from GSM and Fixed phones.
    • "GSM": you can call from GSM only.
    • "Fixed": you can call from a landline only.

    or to get numbers of all departements:

    .all('ISO_code')

    // examples
    console.log('French police number is', sos.police('FR')[0].value);
    console.log('Greece ambulance number is', sos.ambulance('GR')[0].value);
    console.log('Japan fire number is', sos.fire('JP')[0].value);
    console.log('US dispatch number is', sos.dispatch('US')[0].value);
    // output
    /*
    Is Morocco a member of the 112 group false
    Can you call US emergency numbers internationally false
    French police number is 17
    Greece ambulance number is 166
    Japan fire number is 119
    US dispatch number is 911
    */

    To update the emergency numbers dataset

    sos.update() //returns a promise.

    example:

    const updateDataset = async () => {
        let results = await sos.update();
        console.log(results)
    }
     
    // run the updateDataset function every day
    cont dayInMilliseconds = 1000 * 60 * 60 * 24;
    setInterval(function() { updateDataset() }, dayInMilliseconds);

    Contribute

    Please help us keep the emergency numbers dataset up to date

    You can make a pull request adding your country's emergency numbers

    or if you have some time, you can update the dataset from this WikiPedia page and add what's messing.

    Install

    npm i sos

    DownloadsWeekly Downloads

    0

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    76.4 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar