docs: correct onSuccess JSDoc + receivedRedirectUri type docs#399
Open
tsushanth wants to merge 1 commit into
Open
docs: correct onSuccess JSDoc + receivedRedirectUri type docs#399tsushanth wants to merge 1 commit into
tsushanth wants to merge 1 commit into
Conversation
Two small documentation fixes filed as separate issues but touching adjacent surfaces: - `CommonPlaidLinkOptions.onSuccess` JSDoc (`src/types/index.ts:92-93`) referenced `public_key` and had a `connecter`/`connected` typo. The actual first callback argument is `public_token` since the Link Token migration; `public_key` is the deprecated public-key auth flow and is no longer what consumers receive here. The matching `PlaidLinkOnSuccess` type already uses `public_token`. - `README.md:87` documented `receivedRedirectUri` as `string | null | undefined`, but the type in `src/types/index.ts:156` only permits `string | undefined`. Updating the README is the minimal, lower-risk fix; widening the type would change runtime expectations. closes plaid#397 closes plaid#398
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.
Summary
Two small documentation fixes filed as separate issues but touching adjacent surfaces — combined into a single PR.
1.
CommonPlaidLinkOptions.onSuccessJSDoc (closes #397)src/types/index.ts:92-93referencedpublic_keyand had aconnecter/connectedtypo. The first callback argument ispublic_tokensince the Link Token migration;public_keyis the deprecated public-key auth flow and is no longer what consumers receive here. The matchingPlaidLinkOnSuccesstype already usespublic_token.The other surviving
public_keyreferences in this file are inside thePlaidLinkOptionsWithPublicKeyinterface, which is the deprecated public-key flow — those are intentional and left untouched.2.
receivedRedirectUriREADME/type mismatch (closes #398)README.md:87documentedreceivedRedirectUriasstring | null | undefined, but the type atsrc/types/index.ts:156only permitsstring | undefined. Updated the README to match the type — that's the minimal, lower-risk path; widening the type would change the runtime contract.Test plan
PlaidLinkOnSuccesstype already usespublic_token, so JSDoc now matches the typereceivedRedirectUritype unchanged; README now matches it