Package Exports

@okta/configuration-validation
@okta/configuration-validation/dist/lib.esm.js
@okta/configuration-validation/dist/lib.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@okta/configuration-validation) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Okta Configuration Validation

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

Installation

npm install --save @okta/configuration-validation

API

assertIssuer(issuer, [, testing])

Assert that a valid issuer was provided.

// Valid
assertIssuer('https://example.okta.com');

// Throws a ConfigurationValidationError
//
// It looks like there's a typo in your Okta 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');

Contributing

We welcome contributions to all of our open-source packages. Please see the contribution guide to understand how to structure a contribution.

Installing dependencies for contributions

We use yarn for dependency management when developing this package:

yarn install