Skip to content

Type/docs mismatch: receivedRedirectUri docs say string|null|undefined but type only permits string|undefined #398

Description

@Nexory

Summary

README.md line 87 documents receivedRedirectUri as string | null | undefined, but src/types/index.ts:156 declares the type as string | undefined (no null). A consumer following the README and passing null will get a TypeScript error.

What I observed

README.md:87:

| receivedRedirectUri | string \| null \| undefined | ...

src/types/index.ts:156:

receivedRedirectUri?: string;

The type only permits string | undefined.

Impact

Consumers reading the README and explicitly passing null (e.g., for an "OAuth not yet completed" branch) hit a TypeScript compile error. Either the type needs to widen to accept null, or the README needs to drop | null.

Suggested fix

Pick one of:

  1. Widen the type to match README:
    - receivedRedirectUri?: string;
    + receivedRedirectUri?: string | null;
  2. Or update README to match the type by removing | null.

Option 2 is the minimal, low-risk path unless the Plaid Link SDK actually accepts null semantically at runtime.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions