Skip to content

docs: correct onSuccess JSDoc + receivedRedirectUri type docs #399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tsushanth wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: correct onSuccess JSDoc + receivedRedirectUri type docs #399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ the various Link options and the
| `onExit` | `(error: null \| PlaidLinkError, metadata: PlaidLinkOnExitMetadata) => void` |
| `onEvent` | `(eventName: PlaidLinkStableEvent \| string, metadata: PlaidLinkOnEventMetadata) => void` |
| `onLoad` | `() => void` |
| `receivedRedirectUri` | `string \| null \| undefined` |
| `receivedRedirectUri` | `string \| undefined` |
| `cspNonce` | `string \| undefined` |

#### Content Security Policy nonce
Expand Down
4 changes: 2 additions & 2 deletions src/types/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ export type PlaidLinkOnEvent = (
export type PlaidLinkOnLoad = () => void;

export interface CommonPlaidLinkOptions<T> {
// A function that is called when a user has successfully connecter an Item.
// The function should expect two arguments, the public_key and a metadata object
// A function that is called when a user has successfully connected an Item.
// The function should expect two arguments, the public_token and a metadata object
onSuccess: T;
// A callback that is called when a user has specifically exited Link flow
onExit?: PlaidLinkOnExit;
Expand Down