@garbarino/gb-jscommons

A package of common functions used in our JavaScript applications.

Stats

StarsIssuesVersionUpdatedCreatedSize
@garbarino/gb-jscommons
2.0.0a year ago4 years agoMinified + gzip package size for @garbarino/gb-jscommons in KB

Readme

gb-jscommons

M贸dulos comunes a ser usados en las aplicaciones JS / NODE.

Instalaci贸n

npm install @garbarino/gb-jscommons --save

Uso

ES6 modules

Import and be happy

Push notifications

import {isCompatible, subscribeUserToPush, sendSubscriptionToBackEnd} from '@garbarino/gb-jscommons/dist/push-notifications';
if (isCompatible()) {
    subscribeUserToPush().then(
        (subscription) => {
            sendSubscriptionToBackEnd(subscription);
        }
    );
}

ES5 馃懘馃徎

Linkear los archivos de /dist/es5

  • common.js
  • Cada una de las librer铆as que se quiera usar. Ej: push-notifications.js

Usar la variable global gbJsCommons.

Push notifications

gbJsCommons["push-notifications"].subscribeUserToPush()
    .then(function(subscription) {
        gbJsCommons["push-notifications"].sendSubscriptionToBackEnd(subscription)
            .then(function(response) {
                // handle success
            });
    })
    .catch(function(error){
        // handle error
    });

M贸dulos

Push notifications

isCompatible

Devuelve true si el dispositivo tiene soporte. false si no.

canAskForPermission

Devuelve true si el dispositivo tiene soporte y el usuario no deneg贸 el permiso.

subscribeUserToPush

Chequea que el dispositivo sea compatible y devuelve una promesa que resuelve con la pushSubscription

getSubscription

Devuelve una promesa que resuelve con la suscripci贸n a las push o null si no est谩 suscripto. 脷til para no volver a ofrecer la suscripci贸n si ya est谩 registrado.

sendSubscriptionToBackEnd

Recibe la subscription del paso anterior y la env铆a al servidor. Otra promesa que resuelve o dispara un error seg煤n el resultado de la pegada.

C贸mo publicar una nueva versi贸n

  1. Login en npm (cuenta con acceso a la organizaci贸n).
  2. npm run build-prod.
  3. Pushear cambios.
  4. npm version <major|minor|patch>.
  5. Pushear update de versi贸n.
  6. npm publish.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.