session-timer3 v1.6.5

SessionTimer

A SessionTimer é uma biblioteca Typescript criada para redicionar a rota da aplicação após determinado período o qual pode coincidir com o tempo de sessão do servidor.

A classe recebe como parametro o tempo de sessão em segundos e modifica o objeto XMLHttpRequest do browser, a cada requisição a tempo de sessão é reiniciado.

Como Iniciar

1) Em seu projeto Typescript, faça a instalação da presente biblioteca

npm install session-timer

2) Em seguida, faça sua importação em um módulo ou componente da aplicação

import { sessionTimer } from 'session-timer';

3) Exemplo de utilização:

import { sessionTimer } from 'session-timer';
  ...
  // o contrutor da classe SessionTimer recebe como parametro o tempo em segundos.
  let timer = new sessionTimer(180);

  //display é do tipo HTMLElement no qual será exibido o cronometro regressivo para o redirecionamento, é opcional
  let display = document.getElementById('display-timer') as HTMLElement
  timer.display = display;

  //redirect é do tipo string e se refere a rota para qual o usuário será redirecionado
  timer.redirect = {
    url: "", // url que o usuário será redicionado (type string)
    callback: () => console.log("redirectCallBack") //função callback que será executada.
  }  

  // Mensagem que será exibida segundos antes do redicionamento, é opcional
  timer.message = {
    content: "Sua sessão está prestes a expirar!",
    time: 5,            // instante em que será exibida a mensangem ou função de callback (type rangeMessageTime = 5|6|7|8|9|10;)
    color: "primary",   // Cor de exibição da mensagem (type colorsMessage = "blank"|"primary"|"success"|"secondary"|"danger"|"warning"|"info"|"light"|"dark";)
    callback: () => console.log("messageCallBack")    //função callback que será executada.
  }

  timer.formatTimer = "m:ss" // Formato de exibição do tempo de sessão (type format = "hh:mm:ss"|"h:mm:ss"|"mm:ss"|"m:ss"|"ss"|"s")

  timer.start();

  //Outras funções
  timer.stop();
  timer.reset();
  ...