Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@garbarino/gb-jscommons

joacoru632.0.0

A package of common functions used in our JavaScript applications.

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.