Skip to content

Commit 5e705af

Browse files
committed
docs(code): add typedoc to the hook
1 parent cc76ead commit 5e705af

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

lib/use-contentful.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ type ContentfulResponse<T> = {
1111
readonly errors: readonly string[]
1212
}
1313

14+
/**
15+
*
16+
* @param query GraphQL query you want to execute
17+
* @param options An object containing the spaceId and token
18+
* @returns an object containing the data, errors and a loading state
19+
*/
1420
export const useContentful = <T>(
1521
query: string,
1622
{ spaceId, token }: ContentfulOptions,

0 commit comments

Comments
 (0)