docs(identifiabl): fix Quick Start to use the real export name#38
Open
davidcrowe wants to merge 1 commit into
Open
docs(identifiabl): fix Quick Start to use the real export name#38davidcrowe wants to merge 1 commit into
davidcrowe wants to merge 1 commit into
Conversation
The README's Basic Usage and later examples imported and called `createIdentifiablMiddleware`, which the package does not export — the Express middleware is `identifiabl(config)` (createIdentifiablVerifier is the non-Express verifier). Copy-pasting the Quick Start failed at the import line. Rename all five occurrences to the real export; config shape and req.user usage already match identifiabl()'s behavior, so no other changes needed.
Collaborator
Author
|
Reviewed + confirmed green (MERGEABLE/CLEAN). README Quick Start now uses the real export @davidcrowe — needs your merge. No version bump here, so no republish is strictly required; the corrected README will reach npmjs.com on identifiabl's next publish. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The identifiabl README's Basic Usage (and three later examples) import and call
createIdentifiablMiddleware— an export that does not exist. The package exportsidentifiabl(config)(the Express middleware) andcreateIdentifiablVerifier(config)(the non-Express verifier). A reader copy-pasting the Quick Start fails at the very first line:For the identity layer that the whole stack builds on — and during a repo-visibility push — a broken headline example is exactly the wrong first impression.
Fix
Rename all five occurrences to
identifiabl. The documented config (issuer/audience/jwksUri) already matchesIdentifiablConfig, andidentifiabl()setsreq.userexactly as the surrounding prose describes, so no other changes are needed. Verified the built dist exportsidentifiabl.Docs-only; no code or version change.