Skip to content
This repository has been archived by the owner on Oct 24, 2024. It is now read-only.

Update lib.d.ts #1033

Closed
wants to merge 1 commit into from
Closed

Update lib.d.ts #1033

wants to merge 1 commit into from

Conversation

JakeGarrison
Copy link

fix [jwt-verifier]: Adds option parameter for custom jwks to the TS interface. Flags nonce as optional in the verifyIdToken TS declaration.

Docs in readme did not align with TS files as written.

Resolves: #1031

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Adding Tests
  • Build related changes
  • CI related changes
  • Documentation changes
  • Other... Please describe:

What is the current behavior?

When using jwt-verifier in a TypeScript project you will encounter compile time errors when attempting to use the library as written in the docs.

Issue Number: #1031

What is the new behavior?

Typescript projects now accept the additional configuration option, and no longer require the optional parameter.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Reviewers

aligns .ts file with docs in readme. adds custom jwks option to constructor, flags nonce parameter as optional for verifyIdToken
@shuowu-okta
Copy link
Contributor

Internal Ref: OKTA-420060

@denysoblohin-okta
Copy link
Contributor

Copied to okta/okta-jwt-verifier-js#10 and merged

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typescript Options interface missing jwskUri property
3 participants