@pointblue/configuration-validation

Configuration Validation

Standard pattern for validating configuration passed into JavaScript libraries and SDKs.

Installation

npm install --save @pointblue/configuration-validation

API

assertIssuer(issuer, [, testing])

Assert that a valid issuer was provided.

// Valid
assertIssuer("https://example.pointbluetech.com");

// Throws a ConfigurationValidationError
//
// It looks like there's a typo in your domain!
assertIssuer("http://foo.com.com");

// Ignore HTTPS requirement for testing
assertIssuer("http://localhost:8080/", {
  disableHttpsCheck: true,
});

assertClientId(clientId)

Assert that a valid clientId was provided.

assertClientId("abc123");

assertClientSecret(clientSecret)

Assert that a valid clientSecret was provided.

assertClientSecret("superSecret");

assertRedirectUri(redirectUri)

Assert that a valid redirectUri was provided.

assertRedirectUri("https://example.com/callback");

assertAppBaseUrl(appBaseUrl)

Assert that a valid appBaseUrl was provided.

assertAppBaseUrl("https://example.com");