Skip to content
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

Jump to bottom

docs(typedoc): Add frontmatter #7753

Merged
merged 2 commits into from
Jul 18, 2024
Merged

docs(typedoc): Add frontmatter #7753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b292ff2
docs(typedoc): Add frontmatter
lachlancollins Jul 18, 2024
bebe826
Update knip.json
lachlancollins Jul 18, 2024
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
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createbasemutationresult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateBaseMutationResult
title: CreateBaseMutationResult
---

# Type Alias: CreateBaseMutationResult\<TData, TError, TVariables, TContext\>

```ts
Expand All @@ -24,4 +29,4 @@ mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>

## Defined in

[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L113)
[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L113)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createbasequeryoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateBaseQueryOptions
title: CreateBaseQueryOptions
---

# Type Alias: CreateBaseQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey\>

```ts
Expand All @@ -20,4 +25,4 @@ Options for createBaseQuery

## Defined in

[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L23)
[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L23)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createbasequeryresult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateBaseQueryResult
title: CreateBaseQueryResult
---

# Type Alias: CreateBaseQueryResult\<TData, TError\>

```ts
Expand All @@ -14,4 +19,4 @@ Result from createBaseQuery

## Defined in

[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L32)
[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L32)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createinfinitequery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: createInfiniteQuery
title: createInfiniteQuery
---

# Function: createInfiniteQuery()

```ts
Expand Down Expand Up @@ -34,4 +39,4 @@ function createInfiniteQuery<

## Defined in

[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createInfiniteQuery.ts#L16)
[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createInfiniteQuery.ts#L16)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createinfinitequeryoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateInfiniteQueryOptions
title: CreateInfiniteQueryOptions
---

# Type Alias: CreateInfiniteQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam\>

```ts
Expand All @@ -22,4 +27,4 @@ Options for createInfiniteQuery

## Defined in

[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L52)
[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L52)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createinfinitequeryresult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateInfiniteQueryResult
title: CreateInfiniteQueryResult
---

# Type Alias: CreateInfiniteQueryResult\<TData, TError\>

```ts
Expand All @@ -14,4 +19,4 @@ Result from createInfiniteQuery

## Defined in

[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L69)
[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L69)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createmutateasyncfunction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateMutateAsyncFunction
title: CreateMutateAsyncFunction
---

# Type Alias: CreateMutateAsyncFunction\<TData, TError, TVariables, TContext\>

```ts
Expand All @@ -16,4 +21,4 @@ type CreateMutateAsyncFunction<TData, TError, TVariables, TContext>: MutateFunct

## Defined in

[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L106)
[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L106)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createmutatefunction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateMutateFunction
title: CreateMutateFunction
---

# Type Alias: CreateMutateFunction()\<TData, TError, TVariables, TContext\>

```ts
Expand All @@ -24,4 +29,4 @@ type CreateMutateFunction<TData, TError, TVariables, TContext>: (...args) => voi

## Defined in

[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L97)
[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L97)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createmutation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: createMutation
title: createMutation
---

# Function: createMutation()

```ts
Expand Down Expand Up @@ -29,4 +34,4 @@ function createMutation<TData, TError, TVariables, TContext>(

## Defined in

[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createMutation.ts#L13)
[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createMutation.ts#L13)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createmutationoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateMutationOptions
title: CreateMutationOptions
---

# Type Alias: CreateMutationOptions\<TData, TError, TVariables, TContext\>

```ts
Expand All @@ -18,4 +23,4 @@ Options for createMutation

## Defined in

[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L87)
[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L87)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createmutationresult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateMutationResult
title: CreateMutationResult
---

# Type Alias: CreateMutationResult\<TData, TError, TVariables, TContext\>

```ts
Expand All @@ -18,4 +23,4 @@ Result from createMutation

## Defined in

[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L126)
[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L126)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createqueries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: createQueries
title: createQueries
---

# Function: createQueries()

```ts
Expand Down Expand Up @@ -29,4 +34,4 @@ function createQueries<T, TCombinedResult>(

## Defined in

[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L186)
[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L186)
9 changes: 7 additions & 2 deletions docs/framework/svelte/reference/createquery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: createQuery
title: createQuery
---

# Function: createQuery()

## createQuery(options, queryClient)
Expand Down Expand Up @@ -31,7 +36,7 @@ function createQuery<TQueryFnData, TError, TData, TQueryKey>(

### Defined in

[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQuery.ts#L15)
[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQuery.ts#L15)

## createQuery(options, queryClient)

Expand Down Expand Up @@ -64,4 +69,4 @@ function createQuery<TQueryFnData, TError, TData, TQueryKey>(

### Defined in

[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQuery.ts#L27)
[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQuery.ts#L27)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createqueryoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateQueryOptions
title: CreateQueryOptions
---

# Type Alias: CreateQueryOptions\<TQueryFnData, TError, TData, TQueryKey\>

```ts
Expand All @@ -18,4 +23,4 @@ Options for createQuery

## Defined in

[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L38)
[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L38)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/createqueryresult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: CreateQueryResult
title: CreateQueryResult
---

# Type Alias: CreateQueryResult\<TData, TError\>

```ts
Expand All @@ -14,4 +19,4 @@ Result from createQuery

## Defined in

[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L46)
[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L46)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/definedcreatebasequeryresult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: DefinedCreateBaseQueryResult
title: DefinedCreateBaseQueryResult
---

# Type Alias: DefinedCreateBaseQueryResult\<TData, TError\>

```ts
Expand All @@ -14,4 +19,4 @@ Options for createBaseQuery with initialData

## Defined in

[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L75)
[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L75)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/definedcreatequeryresult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: DefinedCreateQueryResult
title: DefinedCreateQueryResult
---

# Type Alias: DefinedCreateQueryResult\<TData, TError\>

```ts
Expand All @@ -14,4 +19,4 @@ Options for createQuery with initialData

## Defined in

[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L81)
[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L81)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/definedinitialdataoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: DefinedInitialDataOptions
title: DefinedInitialDataOptions
---

# Type Alias: DefinedInitialDataOptions\<TQueryFnData, TError, TData, TQueryKey\>

```ts
Expand All @@ -24,4 +29,4 @@ initialData: NonUndefinedGuard<TQueryFnData> | () => NonUndefinedGuard<TQueryFnD

## Defined in

[packages/svelte-query/src/queryOptions.ts:15](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L15)
[packages/svelte-query/src/queryOptions.ts:15](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/queryOptions.ts#L15)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/getisrestoringcontext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: getIsRestoringContext
title: getIsRestoringContext
---

# Function: getIsRestoringContext()

```ts
Expand All @@ -12,4 +17,4 @@ Retrieves a `isRestoring` from Svelte's context

## Defined in

[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L28)
[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L28)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/getqueryclientcontext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: getQueryClientContext
title: getQueryClientContext
---

# Function: getQueryClientContext()

```ts
Expand All @@ -12,4 +17,4 @@ Retrieves a Client from Svelte's context

## Defined in

[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L9)
[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L9)
5 changes: 5 additions & 0 deletions docs/framework/svelte/reference/hydrationboundary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: HydrationBoundary
title: HydrationBoundary
---

# Class: HydrationBoundary\<Props, Events, Slots\>

Base class for Svelte components with some minor dev-enhancements. Used when dev=true.
Expand Down
5 changes: 5 additions & 0 deletions docs/framework/svelte/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: '@tanstack/svelte-query'
title: '@tanstack/svelte-query'
---

# @tanstack/svelte-query

## References
Expand Down
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/infinitequeryoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: infiniteQueryOptions
title: infiniteQueryOptions
---

# Function: infiniteQueryOptions()

```ts
Expand Down Expand Up @@ -41,4 +46,4 @@ function infiniteQueryOptions<

## Defined in

[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/infiniteQueryOptions.ts#L4)
[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/infiniteQueryOptions.ts#L4)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/mutationstateoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: MutationStateOptions
title: MutationStateOptions
---

# Type Alias: MutationStateOptions\<TResult\>

```ts
Expand Down Expand Up @@ -34,4 +39,4 @@ optional select: (mutation) => TResult;

## Defined in

[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L140)
[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L140)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/queriesoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: QueriesOptions
title: QueriesOptions
---

# Type Alias: QueriesOptions\<T, TResult, TDepth\>

```ts
Expand All @@ -16,4 +21,4 @@ QueriesOptions reducer recursively unwraps function arguments to infer/enforce t

## Defined in

[packages/svelte-query/src/createQueries.ts:110](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L110)
[packages/svelte-query/src/createQueries.ts:110](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L110)
7 changes: 6 additions & 1 deletion docs/framework/svelte/reference/queriesresults.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: QueriesResults
title: QueriesResults
---

# Type Alias: QueriesResults\<T, TResult, TDepth\>

```ts
Expand All @@ -16,4 +21,4 @@ QueriesResults reducer recursively maps type param to results

## Defined in

[packages/svelte-query/src/createQueries.ts:152](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L152)
[packages/svelte-query/src/createQueries.ts:152](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L152)
Loading
Loading