❤
npm
Sign UpSign In

jwt-simpleserver-client
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

Javascript JWT Simple Server client library

Home Repository:

https://github.com/Xabaril/JWTSimpleServer

The typescript library will allow you to easily interact will the token endpoint.

Follow this steps to create your client if you are using the browser bundled library:

1. Create the client options

var defaultServerOptions = new JwtSimpleServer.ClientOptions();

Client options parameters have default values listed in this table:

Parameter default value
tokenEndpoint "/token"
host window.location.origin
httpClient XMLHttpRequestClient

NOTE: You can implement your own HttpClient by implementing our HttpClient abstract class

2. Creat the client providing the options object:

var simpleServerClient =  new JwtSimpleServer.ServerClient(defaultServerOptions);
  1. Request an access token by executing requestAccessToken method:
simpleServerClient.requestAccessToken({ userName: "demo", password: "demo" })
    .then(token => {
     // your token object will have the access token and expiral, and if configured: the refresh token
   }):

*Client events

JWT client have several observables you can subscribe to:

Observable return value description
onBeforeRequestAccessToken void Will notify observers before starting the token request to the server
onRequestAccessTokenSuccess Token Will notify observers passing the retrieved token as parameter
onBeforeRequestRefreshToken void Will notify observers before starting the refresh token request to the server
onRequestRefreshTokenSuccess Token Will notify observers passing the retrieved refresh token as parameter

4. Optional: If you want the library to request new access tokens given an interval you can configure the RefreshTokenService

var refreshService = new JwtSimpleServer.RefreshTokenService(simpleServerClient);
 
let onTokenRefreshedFunction = (token) => {
   console.log("Refresh token service:", token);
}
 
//Start the renewal service
refreshService.start({
   intervalSeconds: 10,
   refreshToken,
   onRefreshTokenSuccessCallback: onTokenRefreshedFunction
});
 
//Stop the renewal service
refreshService.stop();

Readme

Keywords

none

Package Sidebar

Install

npm i jwt-simpleserver-client

Weekly Downloads

18

Version

0.0.1

License

ISC

Unpacked Size

74.3 kB

Total Files

31

Last publish

Collaborators

  • carloslanderas
Try on RunKit
Report malware