Skip to content

Mismatch of type and arguments in fn.fetch in README #7

@iainsimmons

Description

@iainsimmons

Describe the bug

The fn.fetch method returned from the fetch$ function, as described in the README says: "In this case, only the request object is passed as the first argument".

The type signature for the fn.fetch method in the README is as follows, which seems to match the description:

  fn.fetch(
    request: RequestInit,
  ) => Promise<
    Awaited<ReturnType<T>> extends JsonResponse<infer R>
      ? R
      : ReturnType<T>
  >

But the Arguments section beneath suggests it still takes a payload and an options: { request }, similar to the fn function.

I might be misunderstanding this, but it doesn't seem to match.

Your Example Website or App

https://github.com/TanStack/bling#returns

Steps to Reproduce the Bug or Issue

  1. Go to https://github.com/TanStack/bling#returns
  2. See the fn.fetch return method

Expected behavior

As a developer reading the documentation, I expect the arguments to reflect those shown in the types.

Screenshots or Videos

No response

Platform

N/A

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions