search

toss / suspensive

Manage asynchronous operations, timing, error handling and detecting intersection of elements easily (one of TanStack Query's community resources)
https://suspensive.org
MIT License
528 stars 51 forks source link

[Feature]: add jsdoc for suspensive/jotai api #1235

Closed gwansikk closed 2 months ago

gwansikk commented 2 months ago

Package Scope

@suspensive/jotai

Description

add jsdoc to suspensive/jotai api

example:


/**
 * This hook is wrapping useQuery of `@tanstack/react-query` v4 with default suspense option.
 * @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery}
 */
export function useSuspenseQuery<>()

Possible Solution

No response

etc.

No response

coauthors[bot] commented 2 months ago

People can be co-author:

Candidate Reasons Count Add this as commit message
@gwansikk https://github.com/toss/suspensive/issues/1235 1 Co-authored-by: gwansikk <39869096+gwansikk@users.noreply.github.com>
@manudeli https://github.com/toss/suspensive/issues/1235#issuecomment-2313929011 1 Co-authored-by: manudeli <61593290+manudeli@users.noreply.github.com>
manudeli commented 2 months ago

Package Scope

@suspensive/jotai

Description

add jsdoc to suspensive/jotai api

example:

/**
 * This hook is wrapping useQuery of `@tanstack/react-query` v4 with default suspense option.
 * @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery}
 */
export function useSuspenseQuery<>()

Possible Solution

No response

etc.

No response

Cool!