1.0.0 • Published 1 year ago

commonjs-oauth-client v1.0.0

Weekly downloads
-
License
ISC
Repository
gitlab
Last release
1 year ago

oauth-client

Helper for exchanging authentication credentials

Config

NameDescription
OAuthUrlOAuth Url for exchanging credentils

For logger configuration properties see the logger documentation

For resilient executor configuration properties see the resilient executor documentation

Usage

/** init oauthclient instance (should use 1 instance per app) */
import { OAuthClient } from 'commonjs-oauth-client';

const loggerConfig = : { logLevel: 'cli', logStyle: 'debug', appName: 'nodejs-commons', moduleName: 'ResilientExecutor' }, // logger configuration

const oauthClient = new OAuthClient('https://auth.dummy.test.url/oauth2/token', loggerconfig);

await oauthClient.exchangeCredentialsForToken({
        username: 'test',
        password: 'test',
      });


/** with resilient executor */

/** init oauthclient instance (should use 1 instance per app) */
import { OAuthClient } from 'commonjs-oauth-client';
import { ResilientExecutor } from 'http-resilient-executor';

const resilientConfig = {
  logger: { logLevel: 'cli', logStyle: 'debug', appName: 'nodejs-commons', moduleName: 'ResilientExecutor' }, // logger configuration
  httpResilienceCBHalfOpenAfterMS: 10 * 1000,
  httpResilienceCBConsecutiveThreshold: 5,
  httpResilienceRetryCount: 3,
};

const resilientExec = new ResilientExecutor(resilientConfig);

const oauthClient = new OAuthClient('https://auth.dummy.test.url/oauth2/token', loggerconfig, resilientExec);

await oauthClient.exchangeCredentialsForToken({
        username: 'test',
        password: 'test',
      });