From 13817e953743537ffb9aab4da174583055be4d81 Mon Sep 17 00:00:00 2001 From: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com> Date: Thu, 18 Jul 2024 12:40:19 +1000 Subject: [PATCH] docs(svelte-query): Auto-generate reference docs (#7751) * docs(svelte-query): Auto-generate reference docs * Fix knip, update exclude --- docs/config.json | 17 + .../reference/createbasemutationresult.md | 27 ++ .../reference/createbasequeryoptions.md | 23 ++ .../svelte/reference/createbasequeryresult.md | 17 + .../svelte/reference/createinfinitequery.md | 37 ++ .../reference/createinfinitequeryoptions.md | 25 ++ .../reference/createinfinitequeryresult.md | 17 + .../reference/createmutateasyncfunction.md | 19 + .../svelte/reference/createmutatefunction.md | 27 ++ .../svelte/reference/createmutation.md | 32 ++ .../svelte/reference/createmutationoptions.md | 21 + .../svelte/reference/createmutationresult.md | 21 + .../svelte/reference/createqueries.md | 32 ++ .../framework/svelte/reference/createquery.md | 67 +++ .../svelte/reference/createqueryoptions.md | 21 + .../svelte/reference/createqueryresult.md | 17 + .../reference/definedcreatebasequeryresult.md | 17 + .../reference/definedcreatequeryresult.md | 17 + .../reference/definedinitialdataoptions.md | 27 ++ .../svelte/reference/getisrestoringcontext.md | 15 + .../svelte/reference/getqueryclientcontext.md | 15 + .../svelte/reference/hydrationboundary.md | 269 ++++++++++++ docs/framework/svelte/reference/index.md | 52 +++ .../svelte/reference/infinitequeryoptions.md | 44 ++ .../svelte/reference/mutationstateoptions.md | 37 ++ .../svelte/reference/queriesoptions.md | 19 + .../svelte/reference/queriesresults.md | 19 + .../svelte/reference/queryoptions.md | 61 +++ .../svelte/reference/setisrestoringcontext.md | 19 + .../svelte/reference/setqueryclientcontext.md | 19 + docs/framework/svelte/reference/storeorval.md | 15 + .../reference/undefinedinitialdataoptions.md | 27 ++ docs/framework/svelte/reference/usehydrate.md | 21 + .../svelte/reference/useisfetching.md | 19 + .../svelte/reference/useismutating.md | 19 + .../svelte/reference/useisrestoring.md | 13 + .../svelte/reference/usemutationstate.md | 23 ++ .../svelte/reference/usequeryclient.md | 17 + knip.json | 2 +- package.json | 3 + pnpm-lock.yaml | 385 ++++++++++++------ scripts/reference-docs.js | 65 +++ scripts/typedoc-remove-prefix.js | 24 ++ 43 files changed, 1556 insertions(+), 127 deletions(-) create mode 100644 docs/framework/svelte/reference/createbasemutationresult.md create mode 100644 docs/framework/svelte/reference/createbasequeryoptions.md create mode 100644 docs/framework/svelte/reference/createbasequeryresult.md create mode 100644 docs/framework/svelte/reference/createinfinitequery.md create mode 100644 docs/framework/svelte/reference/createinfinitequeryoptions.md create mode 100644 docs/framework/svelte/reference/createinfinitequeryresult.md create mode 100644 docs/framework/svelte/reference/createmutateasyncfunction.md create mode 100644 docs/framework/svelte/reference/createmutatefunction.md create mode 100644 docs/framework/svelte/reference/createmutation.md create mode 100644 docs/framework/svelte/reference/createmutationoptions.md create mode 100644 docs/framework/svelte/reference/createmutationresult.md create mode 100644 docs/framework/svelte/reference/createqueries.md create mode 100644 docs/framework/svelte/reference/createquery.md create mode 100644 docs/framework/svelte/reference/createqueryoptions.md create mode 100644 docs/framework/svelte/reference/createqueryresult.md create mode 100644 docs/framework/svelte/reference/definedcreatebasequeryresult.md create mode 100644 docs/framework/svelte/reference/definedcreatequeryresult.md create mode 100644 docs/framework/svelte/reference/definedinitialdataoptions.md create mode 100644 docs/framework/svelte/reference/getisrestoringcontext.md create mode 100644 docs/framework/svelte/reference/getqueryclientcontext.md create mode 100644 docs/framework/svelte/reference/hydrationboundary.md create mode 100644 docs/framework/svelte/reference/index.md create mode 100644 docs/framework/svelte/reference/infinitequeryoptions.md create mode 100644 docs/framework/svelte/reference/mutationstateoptions.md create mode 100644 docs/framework/svelte/reference/queriesoptions.md create mode 100644 docs/framework/svelte/reference/queriesresults.md create mode 100644 docs/framework/svelte/reference/queryoptions.md create mode 100644 docs/framework/svelte/reference/setisrestoringcontext.md create mode 100644 docs/framework/svelte/reference/setqueryclientcontext.md create mode 100644 docs/framework/svelte/reference/storeorval.md create mode 100644 docs/framework/svelte/reference/undefinedinitialdataoptions.md create mode 100644 docs/framework/svelte/reference/usehydrate.md create mode 100644 docs/framework/svelte/reference/useisfetching.md create mode 100644 docs/framework/svelte/reference/useismutating.md create mode 100644 docs/framework/svelte/reference/useisrestoring.md create mode 100644 docs/framework/svelte/reference/usemutationstate.md create mode 100644 docs/framework/svelte/reference/usequeryclient.md create mode 100644 scripts/reference-docs.js create mode 100644 scripts/typedoc-remove-prefix.js diff --git a/docs/config.json b/docs/config.json index d47c5bbb44..f3611017e0 100644 --- a/docs/config.json +++ b/docs/config.json @@ -737,6 +737,23 @@ "to": "framework/solid/reference/createQuery" } ] + }, + { + "label": "svelte", + "children": [ + { + "label": "Svelte Reference", + "to": "framework/svelte/reference/index" + }, + { + "label": "Functions / createQuery", + "to": "framework/svelte/reference/createquery" + }, + { + "label": "Functions / createMutation", + "to": "framework/svelte/reference/createmutation" + } + ] } ] }, diff --git a/docs/framework/svelte/reference/createbasemutationresult.md b/docs/framework/svelte/reference/createbasemutationresult.md new file mode 100644 index 0000000000..5b86e9d9ad --- /dev/null +++ b/docs/framework/svelte/reference/createbasemutationresult.md @@ -0,0 +1,27 @@ +# Type Alias: CreateBaseMutationResult\ + +```ts +type CreateBaseMutationResult: Override, object> & object; +``` + +## Type declaration + +### mutateAsync + +```ts +mutateAsync: CreateMutateAsyncFunction +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `unknown` + +• **TContext** = `unknown` + +## Defined in + +[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L113) diff --git a/docs/framework/svelte/reference/createbasequeryoptions.md b/docs/framework/svelte/reference/createbasequeryoptions.md new file mode 100644 index 0000000000..25ef1688bf --- /dev/null +++ b/docs/framework/svelte/reference/createbasequeryoptions.md @@ -0,0 +1,23 @@ +# Type Alias: CreateBaseQueryOptions\ + +```ts +type CreateBaseQueryOptions: QueryObserverOptions; +``` + +Options for createBaseQuery + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +## Defined in + +[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L23) diff --git a/docs/framework/svelte/reference/createbasequeryresult.md b/docs/framework/svelte/reference/createbasequeryresult.md new file mode 100644 index 0000000000..3b3f6ed07d --- /dev/null +++ b/docs/framework/svelte/reference/createbasequeryresult.md @@ -0,0 +1,17 @@ +# Type Alias: CreateBaseQueryResult\ + +```ts +type CreateBaseQueryResult: Readable>; +``` + +Result from createBaseQuery + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +## Defined in + +[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L32) diff --git a/docs/framework/svelte/reference/createinfinitequery.md b/docs/framework/svelte/reference/createinfinitequery.md new file mode 100644 index 0000000000..7f7b1b96af --- /dev/null +++ b/docs/framework/svelte/reference/createinfinitequery.md @@ -0,0 +1,37 @@ +# Function: createInfiniteQuery() + +```ts +function createInfiniteQuery< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam, +>(options, queryClient?): CreateInfiniteQueryResult +``` + +## Type Parameters + +• **TQueryFnData** + +• **TError** = `Error` + +• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +## Parameters + +• **options**: [`StoreOrVal`](storeorval.md)\<[`CreateInfiniteQueryOptions`](createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>\> + +• **queryClient?**: `QueryClient` + +## Returns + +[`CreateInfiniteQueryResult`](createinfinitequeryresult.md)\<`TData`, `TError`\> + +## Defined in + +[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createInfiniteQuery.ts#L16) diff --git a/docs/framework/svelte/reference/createinfinitequeryoptions.md b/docs/framework/svelte/reference/createinfinitequeryoptions.md new file mode 100644 index 0000000000..4dfd03cd0c --- /dev/null +++ b/docs/framework/svelte/reference/createinfinitequeryoptions.md @@ -0,0 +1,25 @@ +# Type Alias: CreateInfiniteQueryOptions\ + +```ts +type CreateInfiniteQueryOptions: InfiniteQueryObserverOptions; +``` + +Options for createInfiniteQuery + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +## Defined in + +[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L52) diff --git a/docs/framework/svelte/reference/createinfinitequeryresult.md b/docs/framework/svelte/reference/createinfinitequeryresult.md new file mode 100644 index 0000000000..6c3d3fec42 --- /dev/null +++ b/docs/framework/svelte/reference/createinfinitequeryresult.md @@ -0,0 +1,17 @@ +# Type Alias: CreateInfiniteQueryResult\ + +```ts +type CreateInfiniteQueryResult: Readable>; +``` + +Result from createInfiniteQuery + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +## Defined in + +[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L69) diff --git a/docs/framework/svelte/reference/createmutateasyncfunction.md b/docs/framework/svelte/reference/createmutateasyncfunction.md new file mode 100644 index 0000000000..b1dabd4bcc --- /dev/null +++ b/docs/framework/svelte/reference/createmutateasyncfunction.md @@ -0,0 +1,19 @@ +# Type Alias: CreateMutateAsyncFunction\ + +```ts +type CreateMutateAsyncFunction: MutateFunction; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `void` + +• **TContext** = `unknown` + +## Defined in + +[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L106) diff --git a/docs/framework/svelte/reference/createmutatefunction.md b/docs/framework/svelte/reference/createmutatefunction.md new file mode 100644 index 0000000000..4cc1585008 --- /dev/null +++ b/docs/framework/svelte/reference/createmutatefunction.md @@ -0,0 +1,27 @@ +# Type Alias: CreateMutateFunction()\ + +```ts +type CreateMutateFunction: (...args) => void; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `void` + +• **TContext** = `unknown` + +## Parameters + +• ...**args**: `Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TContext`\>\> + +## Returns + +`void` + +## Defined in + +[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L97) diff --git a/docs/framework/svelte/reference/createmutation.md b/docs/framework/svelte/reference/createmutation.md new file mode 100644 index 0000000000..674f454b72 --- /dev/null +++ b/docs/framework/svelte/reference/createmutation.md @@ -0,0 +1,32 @@ +# Function: createMutation() + +```ts +function createMutation( + options, + queryClient?, +): CreateMutationResult +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `Error` + +• **TVariables** = `void` + +• **TContext** = `unknown` + +## Parameters + +• **options**: [`StoreOrVal`](storeorval.md)\<[`CreateMutationOptions`](createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\>\> + +• **queryClient?**: `QueryClient` + +## Returns + +[`CreateMutationResult`](createmutationresult.md)\<`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) diff --git a/docs/framework/svelte/reference/createmutationoptions.md b/docs/framework/svelte/reference/createmutationoptions.md new file mode 100644 index 0000000000..0a1b768416 --- /dev/null +++ b/docs/framework/svelte/reference/createmutationoptions.md @@ -0,0 +1,21 @@ +# Type Alias: CreateMutationOptions\ + +```ts +type CreateMutationOptions: OmitKeyof, "_defaulted">; +``` + +Options for createMutation + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `void` + +• **TContext** = `unknown` + +## Defined in + +[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L87) diff --git a/docs/framework/svelte/reference/createmutationresult.md b/docs/framework/svelte/reference/createmutationresult.md new file mode 100644 index 0000000000..42ef7978f8 --- /dev/null +++ b/docs/framework/svelte/reference/createmutationresult.md @@ -0,0 +1,21 @@ +# Type Alias: CreateMutationResult\ + +```ts +type CreateMutationResult: Readable>; +``` + +Result from createMutation + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `unknown` + +• **TContext** = `unknown` + +## Defined in + +[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L126) diff --git a/docs/framework/svelte/reference/createqueries.md b/docs/framework/svelte/reference/createqueries.md new file mode 100644 index 0000000000..90bdafef57 --- /dev/null +++ b/docs/framework/svelte/reference/createqueries.md @@ -0,0 +1,32 @@ +# Function: createQueries() + +```ts +function createQueries( + __namedParameters, + queryClient?, +): Readable +``` + +## Type Parameters + +• **T** _extends_ `any`[] + +• **TCombinedResult** = `T` _extends_ [] ? [] : `T` _extends_ [`Head`] ? [`GetResults`\<`Head`\>] : `T` _extends_ [`Head`, `...Tail[]`] ? [`...Tail[]`] _extends_ [] ? [] : [`...Tail[]`] _extends_ [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] _extends_ [`Head`, `...Tail[]`] ? [`...Tail[]`] _extends_ [] ? [] : [`...Tail[]`] _extends_ [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] _extends_ [`Head`, `...Tail[]`] ? [`...(...)[]`] _extends_ [] ? [] : ... _extends_ ... ? ... : ... : [`...(...)[]`] _extends_ ...[] ? ...[] : ...[] : [`...Tail[]`] _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[] : `T` _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[] + +## Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.combine?** + +• **\_\_namedParameters.queries?**: [`StoreOrVal`](storeorval.md)\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions, GetOptions] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> + +• **queryClient?**: `QueryClient` + +## Returns + +`Readable`\<`TCombinedResult`\> + +## Defined in + +[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L186) diff --git a/docs/framework/svelte/reference/createquery.md b/docs/framework/svelte/reference/createquery.md new file mode 100644 index 0000000000..3f6fdf6e27 --- /dev/null +++ b/docs/framework/svelte/reference/createquery.md @@ -0,0 +1,67 @@ +# Function: createQuery() + +## createQuery(options, queryClient) + +```ts +function createQuery( + options, + queryClient?, +): CreateQueryResult +``` + +### Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `Error` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +### Parameters + +• **options**: [`StoreOrVal`](storeorval.md)\<[`UndefinedInitialDataOptions`](undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> + +• **queryClient?**: `QueryClient` + +### Returns + +[`CreateQueryResult`](createqueryresult.md)\<`TData`, `TError`\> + +### Defined in + +[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQuery.ts#L15) + +## createQuery(options, queryClient) + +```ts +function createQuery( + options, + queryClient?, +): DefinedCreateQueryResult +``` + +### Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `Error` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +### Parameters + +• **options**: [`StoreOrVal`](storeorval.md)\<[`DefinedInitialDataOptions`](definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> + +• **queryClient?**: `QueryClient` + +### Returns + +[`DefinedCreateQueryResult`](definedcreatequeryresult.md)\<`TData`, `TError`\> + +### Defined in + +[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQuery.ts#L27) diff --git a/docs/framework/svelte/reference/createqueryoptions.md b/docs/framework/svelte/reference/createqueryoptions.md new file mode 100644 index 0000000000..78e50977a0 --- /dev/null +++ b/docs/framework/svelte/reference/createqueryoptions.md @@ -0,0 +1,21 @@ +# Type Alias: CreateQueryOptions\ + +```ts +type CreateQueryOptions: CreateBaseQueryOptions; +``` + +Options for createQuery + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +## Defined in + +[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L38) diff --git a/docs/framework/svelte/reference/createqueryresult.md b/docs/framework/svelte/reference/createqueryresult.md new file mode 100644 index 0000000000..e3ab8e7f9c --- /dev/null +++ b/docs/framework/svelte/reference/createqueryresult.md @@ -0,0 +1,17 @@ +# Type Alias: CreateQueryResult\ + +```ts +type CreateQueryResult: CreateBaseQueryResult; +``` + +Result from createQuery + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +## Defined in + +[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L46) diff --git a/docs/framework/svelte/reference/definedcreatebasequeryresult.md b/docs/framework/svelte/reference/definedcreatebasequeryresult.md new file mode 100644 index 0000000000..1c409ed03b --- /dev/null +++ b/docs/framework/svelte/reference/definedcreatebasequeryresult.md @@ -0,0 +1,17 @@ +# Type Alias: DefinedCreateBaseQueryResult\ + +```ts +type DefinedCreateBaseQueryResult: Readable>; +``` + +Options for createBaseQuery with initialData + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +## Defined in + +[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L75) diff --git a/docs/framework/svelte/reference/definedcreatequeryresult.md b/docs/framework/svelte/reference/definedcreatequeryresult.md new file mode 100644 index 0000000000..31ee691785 --- /dev/null +++ b/docs/framework/svelte/reference/definedcreatequeryresult.md @@ -0,0 +1,17 @@ +# Type Alias: DefinedCreateQueryResult\ + +```ts +type DefinedCreateQueryResult: DefinedCreateBaseQueryResult; +``` + +Options for createQuery with initialData + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +## Defined in + +[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L81) diff --git a/docs/framework/svelte/reference/definedinitialdataoptions.md b/docs/framework/svelte/reference/definedinitialdataoptions.md new file mode 100644 index 0000000000..53e75d6d19 --- /dev/null +++ b/docs/framework/svelte/reference/definedinitialdataoptions.md @@ -0,0 +1,27 @@ +# Type Alias: DefinedInitialDataOptions\ + +```ts +type DefinedInitialDataOptions: CreateQueryOptions & object; +``` + +## Type declaration + +### initialData + +```ts +initialData: NonUndefinedGuard | () => NonUndefinedGuard; +``` + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +## Defined in + +[packages/svelte-query/src/queryOptions.ts:15](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L15) diff --git a/docs/framework/svelte/reference/getisrestoringcontext.md b/docs/framework/svelte/reference/getisrestoringcontext.md new file mode 100644 index 0000000000..1aa0854913 --- /dev/null +++ b/docs/framework/svelte/reference/getisrestoringcontext.md @@ -0,0 +1,15 @@ +# Function: getIsRestoringContext() + +```ts +function getIsRestoringContext(): Readable +``` + +Retrieves a `isRestoring` from Svelte's context + +## Returns + +`Readable`\<`boolean`\> + +## Defined in + +[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L28) diff --git a/docs/framework/svelte/reference/getqueryclientcontext.md b/docs/framework/svelte/reference/getqueryclientcontext.md new file mode 100644 index 0000000000..7d9169ea8d --- /dev/null +++ b/docs/framework/svelte/reference/getqueryclientcontext.md @@ -0,0 +1,15 @@ +# Function: getQueryClientContext() + +```ts +function getQueryClientContext(): QueryClient +``` + +Retrieves a Client from Svelte's context + +## Returns + +`QueryClient` + +## Defined in + +[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L9) diff --git a/docs/framework/svelte/reference/hydrationboundary.md b/docs/framework/svelte/reference/hydrationboundary.md new file mode 100644 index 0000000000..4b81565d73 --- /dev/null +++ b/docs/framework/svelte/reference/hydrationboundary.md @@ -0,0 +1,269 @@ +# Class: HydrationBoundary\ + +Base class for Svelte components with some minor dev-enhancements. Used when dev=true. + +Can be used to create strongly typed Svelte components. + +#### Example: + +You have component library on npm called `component-library`, from which +you export a component called `MyComponent`. For Svelte+TypeScript users, +you want to provide typings. Therefore you create a `index.d.ts`: + +```ts +import { SvelteComponent } from 'svelte' +export class MyComponent extends SvelteComponent<{ foo: string }> {} +``` + +Typing this makes it possible for IDEs like VS Code with the Svelte extension +to provide intellisense and to use the component like this in a Svelte file +with TypeScript: + +```svelte + + + +``` + +## Extends + +- `SvelteComponent_1`\<`Props`, `Events`\> + +## Type Parameters + +• **Props** _extends_ `Record`\<`string`, `any`\> = `any` + +• **Events** _extends_ `Record`\<`string`, `any`\> = `any` + +• **Slots** _extends_ `Record`\<`string`, `any`\> = `any` + +## Indexable + +\[`prop`: `string`\]: `any` + +## Constructors + +### new HydrationBoundary() + +```ts +new HydrationBoundary(options): HydrationBoundary +``` + +#### Parameters + +• **options**: `ComponentConstructorOptions`\<`Props`\> + +#### Returns + +[`HydrationBoundary`](hydrationboundary.md)\<`Props`, `Events`, `Slots`\> + +#### Overrides + +`SvelteComponent_1.constructor` + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:144 + +## Properties + +### $$ + +```ts +$$: any +``` + +### PRIVATE API + +Do not use, may change at any time + +#### Inherited from + +`SvelteComponent_1.$$` + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:102 + +--- + +### $$events_def + +```ts +$$events_def: Events +``` + +For type checking capabilities only. +Does not exist at runtime. + +### DO NOT USE! + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:158 + +--- + +### $$prop_def + +```ts +$$prop_def: Props +``` + +For type checking capabilities only. +Does not exist at runtime. + +### DO NOT USE! + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:151 + +--- + +### $$set + +```ts +$$set: any +``` + +### PRIVATE API + +Do not use, may change at any time + +#### Inherited from + +`SvelteComponent_1.$$set` + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:109 + +--- + +### $$slot_def + +```ts +$$slot_def: Slots +``` + +For type checking capabilities only. +Does not exist at runtime. + +### DO NOT USE! + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:165 + +## Methods + +### $capture_state() + +```ts +$capture_state(): void +``` + +#### Returns + +`void` + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:167 + +--- + +### $destroy() + +```ts +$destroy(): void +``` + +#### Returns + +`void` + +#### Inherited from + +`SvelteComponent_1.$destroy` + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:111 + +--- + +### $inject_state() + +```ts +$inject_state(): void +``` + +#### Returns + +`void` + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:169 + +--- + +### $on() + +```ts +$on(type, callback): () => void +``` + +#### Type Parameters + +• **K** _extends_ `string` + +#### Parameters + +• **type**: `K` + +• **callback**: `undefined` \| `null` \| (`e`) => `void` + +#### Returns + +`Function` + +##### Returns + +`void` + +#### Inherited from + +`SvelteComponent_1.$on` + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:113 + +--- + +### $set() + +```ts +$set(props): void +``` + +#### Parameters + +• **props**: `Partial`\<`Props`\> + +#### Returns + +`void` + +#### Inherited from + +`SvelteComponent_1.$set` + +#### Defined in + +node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:115 diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md new file mode 100644 index 0000000000..4ca9528529 --- /dev/null +++ b/docs/framework/svelte/reference/index.md @@ -0,0 +1,52 @@ +# @tanstack/svelte-query + +## References + +### QueryClientProvider + +Renames and re-exports [HydrationBoundary](hydrationboundary.md) + +## Classes + +- [HydrationBoundary](hydrationboundary.md) + +## Type Aliases + +- [CreateBaseMutationResult](createbasemutationresult.md) +- [CreateBaseQueryOptions](createbasequeryoptions.md) +- [CreateBaseQueryResult](createbasequeryresult.md) +- [CreateInfiniteQueryOptions](createinfinitequeryoptions.md) +- [CreateInfiniteQueryResult](createinfinitequeryresult.md) +- [CreateMutateAsyncFunction](createmutateasyncfunction.md) +- [CreateMutateFunction](createmutatefunction.md) +- [CreateMutationOptions](createmutationoptions.md) +- [CreateMutationResult](createmutationresult.md) +- [CreateQueryOptions](createqueryoptions.md) +- [CreateQueryResult](createqueryresult.md) +- [DefinedCreateBaseQueryResult](definedcreatebasequeryresult.md) +- [DefinedCreateQueryResult](definedcreatequeryresult.md) +- [DefinedInitialDataOptions](definedinitialdataoptions.md) +- [MutationStateOptions](mutationstateoptions.md) +- [QueriesOptions](queriesoptions.md) +- [QueriesResults](queriesresults.md) +- [StoreOrVal](storeorval.md) +- [UndefinedInitialDataOptions](undefinedinitialdataoptions.md) + +## Functions + +- [createInfiniteQuery](createinfinitequery.md) +- [createMutation](createmutation.md) +- [createQueries](createqueries.md) +- [createQuery](createquery.md) +- [getIsRestoringContext](getisrestoringcontext.md) +- [getQueryClientContext](getqueryclientcontext.md) +- [infiniteQueryOptions](infinitequeryoptions.md) +- [queryOptions](queryoptions.md) +- [setIsRestoringContext](setisrestoringcontext.md) +- [setQueryClientContext](setqueryclientcontext.md) +- [useHydrate](usehydrate.md) +- [useIsFetching](useisfetching.md) +- [useIsMutating](useismutating.md) +- [useIsRestoring](useisrestoring.md) +- [useMutationState](usemutationstate.md) +- [useQueryClient](usequeryclient.md) diff --git a/docs/framework/svelte/reference/infinitequeryoptions.md b/docs/framework/svelte/reference/infinitequeryoptions.md new file mode 100644 index 0000000000..1a5bfdf8d9 --- /dev/null +++ b/docs/framework/svelte/reference/infinitequeryoptions.md @@ -0,0 +1,44 @@ +# Function: infiniteQueryOptions() + +```ts +function infiniteQueryOptions< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam, +>( + options, +): CreateInfiniteQueryOptions< + TQueryFnData, + TError, + TData, + TQueryFnData, + TQueryKey, + TPageParam +> +``` + +## Type Parameters + +• **TQueryFnData** + +• **TError** = `Error` + +• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +## Parameters + +• **options**: [`CreateInfiniteQueryOptions`](createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> + +## Returns + +[`CreateInfiniteQueryOptions`](createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> + +## Defined in + +[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/infiniteQueryOptions.ts#L4) diff --git a/docs/framework/svelte/reference/mutationstateoptions.md b/docs/framework/svelte/reference/mutationstateoptions.md new file mode 100644 index 0000000000..de4b70a68d --- /dev/null +++ b/docs/framework/svelte/reference/mutationstateoptions.md @@ -0,0 +1,37 @@ +# Type Alias: MutationStateOptions\ + +```ts +type MutationStateOptions: object; +``` + +Options for useMutationState + +## Type Parameters + +• **TResult** = `MutationState` + +## Type declaration + +### filters? + +```ts +optional filters: MutationFilters; +``` + +### select()? + +```ts +optional select: (mutation) => TResult; +``` + +#### Parameters + +• **mutation**: `Mutation`\<`unknown`, `DefaultError`, `unknown`, `unknown`\> + +#### Returns + +`TResult` + +## Defined in + +[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L140) diff --git a/docs/framework/svelte/reference/queriesoptions.md b/docs/framework/svelte/reference/queriesoptions.md new file mode 100644 index 0000000000..d6db042c9e --- /dev/null +++ b/docs/framework/svelte/reference/queriesoptions.md @@ -0,0 +1,19 @@ +# Type Alias: QueriesOptions\ + +```ts +type QueriesOptions: TDepth["length"] extends MAXIMUM_DEPTH ? QueryObserverOptionsForCreateQueries[] : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions] : T extends [infer Head, ...(infer Tail)] ? QueriesOptions<[...Tail], [...TResult, GetOptions], [...TDepth, 1]> : ReadonlyArray extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[]; +``` + +QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param + +## Type Parameters + +• **T** _extends_ `any`[] + +• **TResult** _extends_ `any`[] = [] + +• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = [] + +## Defined in + +[packages/svelte-query/src/createQueries.ts:110](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L110) diff --git a/docs/framework/svelte/reference/queriesresults.md b/docs/framework/svelte/reference/queriesresults.md new file mode 100644 index 0000000000..f654f008ec --- /dev/null +++ b/docs/framework/svelte/reference/queriesresults.md @@ -0,0 +1,19 @@ +# Type Alias: QueriesResults\ + +```ts +type QueriesResults: TDepth["length"] extends MAXIMUM_DEPTH ? QueryObserverResult[] : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults] : T extends [infer Head, ...(infer Tail)] ? QueriesResults<[...Tail], [...TResult, GetResults], [...TDepth, 1]> : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverResult[] : QueryObserverResult[]; +``` + +QueriesResults reducer recursively maps type param to results + +## Type Parameters + +• **T** _extends_ `any`[] + +• **TResult** _extends_ `any`[] = [] + +• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = [] + +## Defined in + +[packages/svelte-query/src/createQueries.ts:152](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L152) diff --git a/docs/framework/svelte/reference/queryoptions.md b/docs/framework/svelte/reference/queryoptions.md new file mode 100644 index 0000000000..2e886c20d0 --- /dev/null +++ b/docs/framework/svelte/reference/queryoptions.md @@ -0,0 +1,61 @@ +# Function: queryOptions() + +## queryOptions(options) + +```ts +function queryOptions( + options, +): UndefinedInitialDataOptions & object +``` + +### Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `Error` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +### Parameters + +• **options**: [`UndefinedInitialDataOptions`](undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> + +### Returns + +[`UndefinedInitialDataOptions`](undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` + +### Defined in + +[packages/svelte-query/src/queryOptions.ts:26](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L26) + +## queryOptions(options) + +```ts +function queryOptions( + options, +): DefinedInitialDataOptions & object +``` + +### Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `Error` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +### Parameters + +• **options**: [`DefinedInitialDataOptions`](definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> + +### Returns + +[`DefinedInitialDataOptions`](definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` + +### Defined in + +[packages/svelte-query/src/queryOptions.ts:37](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L37) diff --git a/docs/framework/svelte/reference/setisrestoringcontext.md b/docs/framework/svelte/reference/setisrestoringcontext.md new file mode 100644 index 0000000000..e91d799aa4 --- /dev/null +++ b/docs/framework/svelte/reference/setisrestoringcontext.md @@ -0,0 +1,19 @@ +# Function: setIsRestoringContext() + +```ts +function setIsRestoringContext(isRestoring): void +``` + +Sets a `isRestoring` on Svelte's context + +## Parameters + +• **isRestoring**: `Readable`\<`boolean`\> + +## Returns + +`void` + +## Defined in + +[packages/svelte-query/src/context.ts:40](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L40) diff --git a/docs/framework/svelte/reference/setqueryclientcontext.md b/docs/framework/svelte/reference/setqueryclientcontext.md new file mode 100644 index 0000000000..19540cf8a4 --- /dev/null +++ b/docs/framework/svelte/reference/setqueryclientcontext.md @@ -0,0 +1,19 @@ +# Function: setQueryClientContext() + +```ts +function setQueryClientContext(client): void +``` + +Sets a QueryClient on Svelte's context + +## Parameters + +• **client**: `QueryClient` + +## Returns + +`void` + +## Defined in + +[packages/svelte-query/src/context.ts:21](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L21) diff --git a/docs/framework/svelte/reference/storeorval.md b/docs/framework/svelte/reference/storeorval.md new file mode 100644 index 0000000000..748729e4e3 --- /dev/null +++ b/docs/framework/svelte/reference/storeorval.md @@ -0,0 +1,15 @@ +# Type Alias: StoreOrVal\ + +```ts +type StoreOrVal: T | Readable; +``` + +Allows a type to be either the base object or a store of that object + +## Type Parameters + +• **T** + +## Defined in + +[packages/svelte-query/src/types.ts:20](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L20) diff --git a/docs/framework/svelte/reference/undefinedinitialdataoptions.md b/docs/framework/svelte/reference/undefinedinitialdataoptions.md new file mode 100644 index 0000000000..f9d899ba49 --- /dev/null +++ b/docs/framework/svelte/reference/undefinedinitialdataoptions.md @@ -0,0 +1,27 @@ +# Type Alias: UndefinedInitialDataOptions\ + +```ts +type UndefinedInitialDataOptions: CreateQueryOptions & object; +``` + +## Type declaration + +### initialData? + +```ts +optional initialData: undefined; +``` + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +## Defined in + +[packages/svelte-query/src/queryOptions.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L4) diff --git a/docs/framework/svelte/reference/usehydrate.md b/docs/framework/svelte/reference/usehydrate.md new file mode 100644 index 0000000000..60b4773c64 --- /dev/null +++ b/docs/framework/svelte/reference/usehydrate.md @@ -0,0 +1,21 @@ +# Function: useHydrate() + +```ts +function useHydrate(state?, options?, queryClient?): void +``` + +## Parameters + +• **state?**: `unknown` + +• **options?**: `HydrateOptions` + +• **queryClient?**: `QueryClient` + +## Returns + +`void` + +## Defined in + +[packages/svelte-query/src/useHydrate.ts:8](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useHydrate.ts#L8) diff --git a/docs/framework/svelte/reference/useisfetching.md b/docs/framework/svelte/reference/useisfetching.md new file mode 100644 index 0000000000..5cdc279231 --- /dev/null +++ b/docs/framework/svelte/reference/useisfetching.md @@ -0,0 +1,19 @@ +# Function: useIsFetching() + +```ts +function useIsFetching(filters?, queryClient?): Readable +``` + +## Parameters + +• **filters?**: `QueryFilters` + +• **queryClient?**: `QueryClient` + +## Returns + +`Readable`\<`number`\> + +## Defined in + +[packages/svelte-query/src/useIsFetching.ts:10](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useIsFetching.ts#L10) diff --git a/docs/framework/svelte/reference/useismutating.md b/docs/framework/svelte/reference/useismutating.md new file mode 100644 index 0000000000..40d7322b4f --- /dev/null +++ b/docs/framework/svelte/reference/useismutating.md @@ -0,0 +1,19 @@ +# Function: useIsMutating() + +```ts +function useIsMutating(filters?, queryClient?): Readable +``` + +## Parameters + +• **filters?**: `MutationFilters` + +• **queryClient?**: `QueryClient` + +## Returns + +`Readable`\<`number`\> + +## Defined in + +[packages/svelte-query/src/useIsMutating.ts:10](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useIsMutating.ts#L10) diff --git a/docs/framework/svelte/reference/useisrestoring.md b/docs/framework/svelte/reference/useisrestoring.md new file mode 100644 index 0000000000..378744217f --- /dev/null +++ b/docs/framework/svelte/reference/useisrestoring.md @@ -0,0 +1,13 @@ +# Function: useIsRestoring() + +```ts +function useIsRestoring(): Readable +``` + +## Returns + +`Readable`\<`boolean`\> + +## Defined in + +[packages/svelte-query/src/useIsRestoring.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useIsRestoring.ts#L4) diff --git a/docs/framework/svelte/reference/usemutationstate.md b/docs/framework/svelte/reference/usemutationstate.md new file mode 100644 index 0000000000..950ac06081 --- /dev/null +++ b/docs/framework/svelte/reference/usemutationstate.md @@ -0,0 +1,23 @@ +# Function: useMutationState() + +```ts +function useMutationState(options, queryClient?): Readable +``` + +## Type Parameters + +• **TResult** = `MutationState`\<`unknown`, `Error`, `unknown`, `unknown`\> + +## Parameters + +• **options**: [`MutationStateOptions`](mutationstateoptions.md)\<`TResult`\> = `{}` + +• **queryClient?**: `QueryClient` + +## Returns + +`Readable`\<`TResult`[]\> + +## Defined in + +[packages/svelte-query/src/useMutationState.ts:24](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useMutationState.ts#L24) diff --git a/docs/framework/svelte/reference/usequeryclient.md b/docs/framework/svelte/reference/usequeryclient.md new file mode 100644 index 0000000000..1f5105108d --- /dev/null +++ b/docs/framework/svelte/reference/usequeryclient.md @@ -0,0 +1,17 @@ +# Function: useQueryClient() + +```ts +function useQueryClient(queryClient?): QueryClient +``` + +## Parameters + +• **queryClient?**: `QueryClient` + +## Returns + +`QueryClient` + +## Defined in + +[packages/svelte-query/src/useQueryClient.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useQueryClient.ts#L4) diff --git a/knip.json b/knip.json index 2e75d9154a..7299499950 100644 --- a/knip.json +++ b/knip.json @@ -1,6 +1,6 @@ { "$schema": "https://unpkg.com/knip@5/schema.json", - "ignore": [".pnpmfile.cjs"], + "ignore": [".pnpmfile.cjs", "scripts/typedoc-remove-prefix.js"], "ignoreWorkspaces": ["examples/**", "integrations/**"], "workspaces": { "packages/query-codemods": { diff --git a/package.json b/package.json index cbe3dd5d39..391ab769bd 100644 --- a/package.json +++ b/package.json @@ -28,6 +28,7 @@ "dev": "pnpm run watch", "prettier": "prettier --ignore-unknown '**/*'", "prettier:write": "pnpm run prettier --write", + "docs:reference": "node scripts/reference-docs.js", "cipublish": "node scripts/publish.js" }, "nx": { @@ -68,6 +69,8 @@ "sherif": "^0.10.0", "solid-js": "^1.8.17", "tsup": "^8.0.2", + "typedoc": "^0.26.4", + "typedoc-plugin-markdown": "^4.2.1", "typescript": "5.3.3", "typescript47": "npm:typescript@4.7", "typescript48": "npm:typescript@4.8", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 6201b5053f..16b991a7be 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -105,6 +105,12 @@ importers: tsup: specifier: ^8.0.2 version: 8.0.2(@microsoft/api-extractor@7.46.2(@types/node@20.14.10))(postcss@8.4.39)(typescript@5.3.3) + typedoc: + specifier: ^0.26.4 + version: 0.26.4(typescript@5.3.3) + typedoc-plugin-markdown: + specifier: ^4.2.1 + version: 4.2.1(typedoc@0.26.4(typescript@5.3.3)) typescript: specifier: 5.3.3 version: 5.3.3 @@ -165,7 +171,7 @@ importers: devDependencies: '@angular-devkit/build-angular': specifier: ^17.3.8 - version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.20.1)))(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) + version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3)(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) '@angular/cli': specifier: ^17.3.8 version: 17.3.8(chokidar@3.6.0) @@ -211,7 +217,7 @@ importers: devDependencies: '@angular-devkit/build-angular': specifier: ^17.3.8 - version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.19.11)))(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) + version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3)(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) '@angular/cli': specifier: ^17.3.8 version: 17.3.8(chokidar@3.6.0) @@ -260,7 +266,7 @@ importers: devDependencies: '@angular-devkit/build-angular': specifier: ^17.3.8 - version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.19.11)))(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) + version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3)(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) '@angular/cli': specifier: ^17.3.8 version: 17.3.8(chokidar@3.6.0) @@ -309,7 +315,7 @@ importers: devDependencies: '@angular-devkit/build-angular': specifier: ^17.3.8 - version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.19.11)))(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) + version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3)(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) '@angular/cli': specifier: ^17.3.8 version: 17.3.8(chokidar@3.6.0) @@ -1645,7 +1651,7 @@ importers: devDependencies: '@angular-devkit/build-angular': specifier: ^17.3.8 - version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.19.11)))(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) + version: 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3)(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) '@angular/cli': specifier: ^17.3.8 version: 17.3.8(chokidar@3.6.0) @@ -2163,7 +2169,7 @@ importers: devDependencies: '@sveltejs/package': specifier: ^2.3.1 - version: 2.3.1(svelte@4.2.18)(typescript@5.4.2) + version: 2.3.1(svelte@4.2.18)(typescript@5.3.3) '@sveltejs/vite-plugin-svelte': specifier: ^3.1.0 version: 3.1.0(svelte@4.2.18)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1)) @@ -5924,6 +5930,9 @@ packages: '@segment/loosely-validate-event@2.0.0': resolution: {integrity: sha512-ZMCSfztDBqwotkl848ODgVcAmN4OItEWDCkshcKz0/W6gGSQayuuCtWV/MlodFivAZD793d6UgANd6wCXUfrIw==} + '@shikijs/core@1.10.3': + resolution: {integrity: sha512-D45PMaBaeDHxww+EkcDQtDAtzv00Gcsp72ukBtaLSmqRvh0WgGMq3Al0rl1QQBZfuneO75NXMIzEZGFitThWbg==} + '@shikijs/core@1.6.0': resolution: {integrity: sha512-NIEAi5U5R7BLkbW1pG/ZKu3eb1lzc3/+jD0lFsuxMT7zjaf9bbNwdNyMr7zh/Zl8EXQtQ+MYBAt5G+JLu+5DlA==} @@ -11438,6 +11447,9 @@ packages: resolution: {integrity: sha512-cNOjgCnLB+FnvWWtyRTzmB3POJ+cXxTA81LoW7u8JdmhfXzriropYwpjShnz1QLLWsQwY7nIxoDmcPTwphDK9w==} engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + linkify-it@5.0.0: + resolution: {integrity: sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==} + lint-staged@15.2.2: resolution: {integrity: sha512-TiTt93OPh1OZOsb5B7k96A/ATl2AjIZo+vnzFZ6oHK5FuTk63ByDtxGQpHm+kFETjEWqgkF95M8FRXKR/LEBcw==} engines: {node: '>=18.12.0'} @@ -11611,6 +11623,9 @@ packages: resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==} engines: {node: '>=10'} + lunr@2.3.9: + resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} + lz-string@1.5.0: resolution: {integrity: sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==} hasBin: true @@ -11658,6 +11673,10 @@ packages: resolution: {integrity: sha512-4y7uGv8bd2WdM9vpQsiQNo41Ln1NvhvDRuVt0k2JZQ+ezN2uaQes7lZeZ+QQUHOLQAtDaBJ+7wCbi+ab/KFs+w==} engines: {node: '>=0.10.0'} + markdown-it@14.1.0: + resolution: {integrity: sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==} + hasBin: true + markdown-table@3.0.3: resolution: {integrity: sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==} @@ -11743,6 +11762,9 @@ packages: mdn-data@2.0.4: resolution: {integrity: sha512-iV3XNKw06j5Q7mi6h+9vbx23Tv7JkjEVgKHW4pimwyDGWm0OIQntJJ+u1C6mg6mK1EaTv42XQ7w76yuzH7M2cA==} + mdurl@2.0.0: + resolution: {integrity: sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==} + media-typer@0.3.0: resolution: {integrity: sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==} engines: {node: '>= 0.6'} @@ -12033,6 +12055,10 @@ packages: resolution: {integrity: sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw==} engines: {node: '>=16 || 14 >=14.17'} + minimatch@9.0.5: + resolution: {integrity: sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==} + engines: {node: '>=16 || 14 >=14.17'} + minimist@1.2.8: resolution: {integrity: sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==} @@ -13926,6 +13952,10 @@ packages: pumpify@1.5.1: resolution: {integrity: sha512-oClZI37HvuUJJxSKKrC17bZ9Cu0ZYhEAGPsPUy9KlMUmv9dKX2o77RUmq7f3XjIxbwyGwYzbzQ1L2Ks8sIradQ==} + punycode.js@2.3.1: + resolution: {integrity: sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==} + engines: {node: '>=6'} + punycode@1.4.1: resolution: {integrity: sha512-jmYNElW7yvO7TV33CjSmvSiE2yco3bV2czu/OzDKdMNVZQWfxCblURLhf+47syQRBntjfLdd/H0egrzIG+oaFQ==} @@ -14950,6 +14980,9 @@ packages: resolution: {integrity: sha512-KAKYAnhgJaz2F7EFowXU3xrukrRWkNsC8OhmTD9TW84mu0Pb6jI2GabFd9U/umMTVshDjS9l43D1JAGx/e0JdQ==} hasBin: true + shiki@1.10.3: + resolution: {integrity: sha512-eneCLncGuvPdTutJuLyUGS8QNPAVFO5Trvld2wgEq1e002mwctAhJKeMGWtWVXOIEzmlcLRqcgPSorR6AVzOmQ==} + shiki@1.6.0: resolution: {integrity: sha512-P31ROeXcVgW/k3Z+vUUErcxoTah7ZRaimctOpzGuqAntqnnSmx1HOsvnbAB8Z2qfXPRhw61yptAzCsuKOhTHwQ==} @@ -16071,6 +16104,19 @@ packages: typedarray@0.0.6: resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} + typedoc-plugin-markdown@4.2.1: + resolution: {integrity: sha512-7hQt/1WaW/VI4+x3sxwcCGsEylP1E1GvF6OTTELK5sfTEp6AeK+83jkCOgZGp1pI2DiOammMYQMnxxOny9TKsQ==} + engines: {node: '>= 18'} + peerDependencies: + typedoc: 0.26.x + + typedoc@0.26.4: + resolution: {integrity: sha512-FlW6HpvULDKgc3rK04V+nbFyXogPV88hurarDPOjuuB5HAwuAlrCMQ5NeH7Zt68a/ikOKu6Z/0hFXAeC9xPccQ==} + engines: {node: '>= 18'} + hasBin: true + peerDependencies: + typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x + types-react-dom@19.0.0-rc.1: resolution: {integrity: sha512-VSLZJl8VXCD0fAWp7DUTFUDCcZ8DVXOQmjhJMD03odgeFmu14ZQJHCXeETm3BEAhJqfgJaFkLnGkQv88sRx0fQ==} @@ -16136,6 +16182,9 @@ packages: ua-parser-js@1.0.36: resolution: {integrity: sha512-znuyCIXzl8ciS3+y3fHJI/2OhQIXbXw9MWC/o3qwyR+RGppjZHrM27CGFSKCJXi2Kctiz537iOu2KnXs1lMQhw==} + uc.micro@2.1.0: + resolution: {integrity: sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==} + ufo@1.5.3: resolution: {integrity: sha512-Y7HYmWaFwPUmkoQCUIAYpKqkOf+SbVj/2fJJZ4RJMCfZp0rTGwRbzQD+HghfnhKOjL9E01okqz+ncJskGYfBNw==} @@ -17477,7 +17526,7 @@ snapshots: '@analogjs/vite-plugin-angular@1.3.1(@angular-devkit/build-angular@17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.19.11)))(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3))(@ngtools/webpack@17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(typescript@5.3.3)(webpack@5.90.3(esbuild@0.19.11)))': dependencies: - '@angular-devkit/build-angular': 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.19.11)))(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) + '@angular-devkit/build-angular': 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3)(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3) '@ngtools/webpack': 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(typescript@5.3.3)(webpack@5.90.3(esbuild@0.19.11)) ts-morph: 21.0.1 @@ -17490,97 +17539,7 @@ snapshots: transitivePeerDependencies: - chokidar - '@angular-devkit/build-angular@17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.19.11)))(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3)': - dependencies: - '@ampproject/remapping': 2.3.0 - '@angular-devkit/architect': 0.1703.8(chokidar@3.6.0) - '@angular-devkit/build-webpack': 0.1703.8(chokidar@3.6.0)(webpack-dev-server@4.15.1(webpack@5.90.3(esbuild@0.20.1)))(webpack@5.90.3(esbuild@0.20.1)) - '@angular-devkit/core': 17.3.8(chokidar@3.6.0) - '@angular/compiler-cli': 17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3) - '@babel/core': 7.24.0 - '@babel/generator': 7.23.6 - '@babel/helper-annotate-as-pure': 7.22.5 - '@babel/helper-split-export-declaration': 7.22.6 - '@babel/plugin-transform-async-generator-functions': 7.23.9(@babel/core@7.24.0) - '@babel/plugin-transform-async-to-generator': 7.23.3(@babel/core@7.24.0) - '@babel/plugin-transform-runtime': 7.24.0(@babel/core@7.24.0) - '@babel/preset-env': 7.24.0(@babel/core@7.24.0) - '@babel/runtime': 7.24.0 - '@discoveryjs/json-ext': 0.5.7 - '@ngtools/webpack': 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(typescript@5.3.3)(webpack@5.90.3(esbuild@0.19.11)) - '@vitejs/plugin-basic-ssl': 1.1.0(vite@5.1.7(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1)) - ansi-colors: 4.1.3 - autoprefixer: 10.4.18(postcss@8.4.35) - babel-loader: 9.1.3(@babel/core@7.24.0)(webpack@5.90.3(esbuild@0.20.1)) - babel-plugin-istanbul: 6.1.1 - browserslist: 4.23.0 - copy-webpack-plugin: 11.0.0(webpack@5.90.3(esbuild@0.20.1)) - critters: 0.0.22 - css-loader: 6.10.0(webpack@5.90.3(esbuild@0.19.11)) - esbuild-wasm: 0.20.1 - fast-glob: 3.3.2 - http-proxy-middleware: 2.0.6(@types/express@4.17.20) - https-proxy-agent: 7.0.4 - inquirer: 9.2.15 - jsonc-parser: 3.2.1 - karma-source-map-support: 1.4.0 - less: 4.2.0 - less-loader: 11.1.0(less@4.2.0)(webpack@5.90.3(esbuild@0.20.1)) - license-webpack-plugin: 4.0.2(webpack@5.90.3(esbuild@0.20.1)) - loader-utils: 3.2.1 - magic-string: 0.30.8 - mini-css-extract-plugin: 2.8.1(webpack@5.90.3(esbuild@0.19.11)) - mrmime: 2.0.0 - open: 8.4.2 - ora: 5.4.1 - parse5-html-rewriting-stream: 7.0.0 - picomatch: 4.0.1 - piscina: 4.4.0 - postcss: 8.4.35 - postcss-loader: 8.1.1(postcss@8.4.35)(typescript@5.3.3)(webpack@5.90.3(esbuild@0.20.1)) - resolve-url-loader: 5.0.0 - rxjs: 7.8.1 - sass: 1.71.1 - sass-loader: 14.1.1(sass@1.71.1)(webpack@5.90.3(esbuild@0.20.1)) - semver: 7.6.0 - source-map-loader: 5.0.0(webpack@5.90.3(esbuild@0.20.1)) - source-map-support: 0.5.21 - terser: 5.29.1 - tree-kill: 1.2.2 - tslib: 2.6.2 - typescript: 5.3.3 - undici: 6.11.1 - vite: 5.1.7(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1) - watchpack: 2.4.0 - webpack: 5.90.3(esbuild@0.19.11) - webpack-dev-middleware: 6.1.2(webpack@5.90.3(esbuild@0.20.1)) - webpack-dev-server: 4.15.1(webpack@5.90.3(esbuild@0.19.11)) - webpack-merge: 5.10.0 - webpack-subresource-integrity: 5.1.0(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.19.11)))(webpack@5.90.3(esbuild@0.20.1)) - optionalDependencies: - esbuild: 0.20.1 - ng-packagr: 17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3) - tailwindcss: 3.4.3 - transitivePeerDependencies: - - '@rspack/core' - - '@swc/core' - - '@types/express' - - '@types/node' - - bufferutil - - chokidar - - debug - - html-webpack-plugin - - lightningcss - - node-sass - - sass-embedded - - stylus - - sugarss - - supports-color - - uglify-js - - utf-8-validate - - webpack-cli - - '@angular-devkit/build-angular@17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.20.1)))(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3)': + '@angular-devkit/build-angular@17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(@types/express@4.17.20)(@types/node@20.14.10)(chokidar@3.6.0)(html-webpack-plugin@5.5.3)(ng-packagr@17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3))(tailwindcss@3.4.3)(typescript@5.3.3)': dependencies: '@ampproject/remapping': 2.3.0 '@angular-devkit/architect': 0.1703.8(chokidar@3.6.0) @@ -17597,7 +17556,7 @@ snapshots: '@babel/preset-env': 7.24.0(@babel/core@7.24.0) '@babel/runtime': 7.24.0 '@discoveryjs/json-ext': 0.5.7 - '@ngtools/webpack': 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(typescript@5.3.3)(webpack@5.90.3(esbuild@0.19.11)) + '@ngtools/webpack': 17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(typescript@5.3.3)(webpack@5.90.3(esbuild@0.20.1)) '@vitejs/plugin-basic-ssl': 1.1.0(vite@5.1.7(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1)) ansi-colors: 4.1.3 autoprefixer: 10.4.18(postcss@8.4.35) @@ -17606,7 +17565,7 @@ snapshots: browserslist: 4.23.0 copy-webpack-plugin: 11.0.0(webpack@5.90.3(esbuild@0.20.1)) critters: 0.0.22 - css-loader: 6.10.0(webpack@5.90.3(esbuild@0.19.11)) + css-loader: 6.10.0(webpack@5.90.3(esbuild@0.20.1)) esbuild-wasm: 0.20.1 fast-glob: 3.3.2 http-proxy-middleware: 2.0.6(@types/express@4.17.20) @@ -17619,7 +17578,7 @@ snapshots: license-webpack-plugin: 4.0.2(webpack@5.90.3(esbuild@0.20.1)) loader-utils: 3.2.1 magic-string: 0.30.8 - mini-css-extract-plugin: 2.8.1(webpack@5.90.3(esbuild@0.19.11)) + mini-css-extract-plugin: 2.8.1(webpack@5.90.3(esbuild@0.20.1)) mrmime: 2.0.0 open: 8.4.2 ora: 5.4.1 @@ -17642,11 +17601,11 @@ snapshots: undici: 6.11.1 vite: 5.1.7(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1) watchpack: 2.4.0 - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) webpack-dev-middleware: 6.1.2(webpack@5.90.3(esbuild@0.20.1)) - webpack-dev-server: 4.15.1(webpack@5.90.3(esbuild@0.19.11)) + webpack-dev-server: 4.15.1(webpack@5.90.3(esbuild@0.20.1)) webpack-merge: 5.10.0 - webpack-subresource-integrity: 5.1.0(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.20.1)))(webpack@5.90.3(esbuild@0.20.1)) + webpack-subresource-integrity: 5.1.0(html-webpack-plugin@5.5.3)(webpack@5.90.3(esbuild@0.20.1)) optionalDependencies: esbuild: 0.20.1 ng-packagr: 17.3.0(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(tailwindcss@3.4.3)(tslib@2.6.2)(typescript@5.3.3) @@ -17674,8 +17633,8 @@ snapshots: dependencies: '@angular-devkit/architect': 0.1703.8(chokidar@3.6.0) rxjs: 7.8.1 - webpack: 5.90.3(esbuild@0.19.11) - webpack-dev-server: 4.15.1(webpack@5.90.3(esbuild@0.19.11)) + webpack: 5.90.3(esbuild@0.20.1) + webpack-dev-server: 4.15.1(webpack@5.90.3(esbuild@0.20.1)) transitivePeerDependencies: - chokidar @@ -21375,6 +21334,12 @@ snapshots: typescript: 5.3.3 webpack: 5.90.3(esbuild@0.19.11) + '@ngtools/webpack@17.3.8(@angular/compiler-cli@17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3))(typescript@5.3.3)(webpack@5.90.3(esbuild@0.20.1))': + dependencies: + '@angular/compiler-cli': 17.3.10(@angular/compiler@17.3.10(@angular/core@17.3.10(rxjs@7.8.1)(zone.js@0.14.6)))(typescript@5.3.3) + typescript: 5.3.3 + webpack: 5.90.3(esbuild@0.20.1) + '@nodelib/fs.scandir@2.1.5': dependencies: '@nodelib/fs.stat': 2.0.5 @@ -22220,6 +22185,10 @@ snapshots: component-type: 1.2.1 join-component: 1.1.0 + '@shikijs/core@1.10.3': + dependencies: + '@types/hast': 3.0.4 + '@shikijs/core@1.6.0': {} '@sideway/address@4.1.4': @@ -22429,6 +22398,17 @@ snapshots: tiny-glob: 0.2.9 vite: 5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1) + '@sveltejs/package@2.3.1(svelte@4.2.18)(typescript@5.3.3)': + dependencies: + chokidar: 3.6.0 + kleur: 4.1.5 + sade: 1.8.1 + semver: 7.6.2 + svelte: 4.2.18 + svelte2tsx: 0.7.1(svelte@4.2.18)(typescript@5.3.3) + transitivePeerDependencies: + - typescript + '@sveltejs/package@2.3.1(svelte@4.2.18)(typescript@5.4.2)': dependencies: chokidar: 3.6.0 @@ -24146,7 +24126,7 @@ snapshots: '@babel/core': 7.24.0 find-cache-dir: 4.0.0 schema-utils: 4.2.0 - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) babel-plugin-add-module-exports@0.2.1: {} @@ -25150,7 +25130,7 @@ snapshots: normalize-path: 3.0.0 schema-utils: 4.2.0 serialize-javascript: 6.0.1 - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) core-js-compat@3.37.1: dependencies: @@ -25434,6 +25414,19 @@ snapshots: optionalDependencies: webpack: 5.90.3(esbuild@0.19.11) + css-loader@6.10.0(webpack@5.90.3(esbuild@0.20.1)): + dependencies: + icss-utils: 5.1.0(postcss@8.4.38) + postcss: 8.4.38 + postcss-modules-extract-imports: 3.0.0(postcss@8.4.38) + postcss-modules-local-by-default: 4.0.5(postcss@8.4.38) + postcss-modules-scope: 3.2.0(postcss@8.4.38) + postcss-modules-values: 4.0.0(postcss@8.4.38) + postcss-value-parser: 4.2.0 + semver: 7.6.2 + optionalDependencies: + webpack: 5.90.3(esbuild@0.20.1) + css-minimizer-webpack-plugin@3.4.1(esbuild@0.19.11)(webpack@5.90.3(esbuild@0.19.11)): dependencies: cssnano: 5.1.15(postcss@8.4.38) @@ -29091,7 +29084,7 @@ snapshots: dependencies: klona: 2.0.6 less: 4.2.0 - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) less@4.2.0: dependencies: @@ -29125,7 +29118,7 @@ snapshots: dependencies: webpack-sources: 3.2.3 optionalDependencies: - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) lie@3.1.1: dependencies: @@ -29193,6 +29186,10 @@ snapshots: lines-and-columns@2.0.3: {} + linkify-it@5.0.0: + dependencies: + uc.micro: 2.1.0 + lint-staged@15.2.2: dependencies: chalk: 5.3.0 @@ -29399,6 +29396,8 @@ snapshots: dependencies: yallist: 4.0.0 + lunr@2.3.9: {} + lz-string@1.5.0: {} magic-string@0.25.9: @@ -29464,6 +29463,15 @@ snapshots: dependencies: object-visit: 1.0.1 + markdown-it@14.1.0: + dependencies: + argparse: 2.0.1 + entities: 4.5.0 + linkify-it: 5.0.0 + mdurl: 2.0.0 + punycode.js: 2.3.1 + uc.micro: 2.1.0 + markdown-table@3.0.3: {} marked-terminal@6.2.0(marked@9.1.6): @@ -29634,6 +29642,8 @@ snapshots: mdn-data@2.0.4: {} + mdurl@2.0.0: {} + media-typer@0.3.0: {} memfs@3.5.3: @@ -30101,6 +30111,12 @@ snapshots: tapable: 2.2.1 webpack: 5.90.3(esbuild@0.19.11) + mini-css-extract-plugin@2.8.1(webpack@5.90.3(esbuild@0.20.1)): + dependencies: + schema-utils: 4.2.0 + tapable: 2.2.1 + webpack: 5.90.3(esbuild@0.20.1) + minimalistic-assert@1.0.1: {} minimalistic-crypto-utils@1.0.1: {} @@ -30125,6 +30141,10 @@ snapshots: dependencies: brace-expansion: 2.0.1 + minimatch@9.0.5: + dependencies: + brace-expansion: 2.0.1 + minimist@1.2.8: {} minipass-collect@1.0.2: @@ -31751,7 +31771,7 @@ snapshots: postcss: 8.4.35 semver: 7.6.2 optionalDependencies: - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) transitivePeerDependencies: - typescript @@ -32472,6 +32492,8 @@ snapshots: inherits: 2.0.4 pump: 2.0.1 + punycode.js@2.3.1: {} + punycode@1.4.1: {} punycode@2.3.1: {} @@ -32924,7 +32946,7 @@ snapshots: source-map-loader: 3.0.2(webpack@5.90.3(esbuild@0.19.11)) style-loader: 3.3.3(webpack@5.90.3(esbuild@0.19.11)) tailwindcss: 3.4.3 - terser-webpack-plugin: 5.3.10(esbuild@0.19.11)(webpack@5.90.3(esbuild@0.19.11)) + terser-webpack-plugin: 5.3.10(esbuild@0.19.11)(webpack@5.90.3(esbuild@0.20.1)) webpack: 5.90.3(esbuild@0.19.11) webpack-dev-server: 4.15.1(webpack@5.90.3(esbuild@0.19.11)) webpack-manifest-plugin: 4.1.1(webpack@5.90.3(esbuild@0.19.11)) @@ -33574,7 +33596,7 @@ snapshots: neo-async: 2.6.2 optionalDependencies: sass: 1.71.1 - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) sass@1.71.1: dependencies: @@ -33844,6 +33866,11 @@ snapshots: sherif-windows-arm64: 0.10.0 sherif-windows-x64: 0.10.0 + shiki@1.10.3: + dependencies: + '@shikijs/core': 1.10.3 + '@types/hast': 3.0.4 + shiki@1.6.0: dependencies: '@shikijs/core': 1.6.0 @@ -34052,7 +34079,7 @@ snapshots: dependencies: iconv-lite: 0.6.3 source-map-js: 1.2.0 - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) source-map-resolve@0.5.3: dependencies: @@ -34563,6 +34590,13 @@ snapshots: sass: 1.71.1 typescript: 5.3.3 + svelte2tsx@0.7.1(svelte@4.2.18)(typescript@5.3.3): + dependencies: + dedent-js: 1.0.1 + pascal-case: 3.1.2 + svelte: 4.2.18 + typescript: 5.3.3 + svelte2tsx@0.7.1(svelte@4.2.18)(typescript@5.4.2): dependencies: dedent-js: 1.0.1 @@ -34747,7 +34781,7 @@ snapshots: transitivePeerDependencies: - bluebird - terser-webpack-plugin@5.3.10(esbuild@0.19.11)(webpack@5.90.3(esbuild@0.19.11)): + terser-webpack-plugin@5.3.10(esbuild@0.19.11)(webpack@5.90.3(esbuild@0.20.1)): dependencies: '@jridgewell/trace-mapping': 0.3.25 jest-worker: 27.5.1 @@ -34758,6 +34792,17 @@ snapshots: optionalDependencies: esbuild: 0.19.11 + terser-webpack-plugin@5.3.10(esbuild@0.20.1)(webpack@5.90.3(esbuild@0.20.1)): + dependencies: + '@jridgewell/trace-mapping': 0.3.25 + jest-worker: 27.5.1 + schema-utils: 3.3.0 + serialize-javascript: 6.0.1 + terser: 5.29.1 + webpack: 5.90.3(esbuild@0.20.1) + optionalDependencies: + esbuild: 0.20.1 + terser@4.8.1: dependencies: acorn: 8.11.3 @@ -35128,6 +35173,19 @@ snapshots: typedarray@0.0.6: {} + typedoc-plugin-markdown@4.2.1(typedoc@0.26.4(typescript@5.3.3)): + dependencies: + typedoc: 0.26.4(typescript@5.3.3) + + typedoc@0.26.4(typescript@5.3.3): + dependencies: + lunr: 2.3.9 + markdown-it: 14.1.0 + minimatch: 9.0.5 + shiki: 1.10.3 + typescript: 5.3.3 + yaml: 2.4.5 + types-react-dom@19.0.0-rc.1: dependencies: '@types/react': types-react@19.0.0-rc.1 @@ -35171,6 +35229,8 @@ snapshots: ua-parser-js@1.0.36: {} + uc.micro@2.1.0: {} + ufo@1.5.3: {} unbox-primitive@1.0.2: @@ -36008,6 +36068,15 @@ snapshots: schema-utils: 4.2.0 webpack: 5.90.3(esbuild@0.19.11) + webpack-dev-middleware@5.3.3(webpack@5.90.3(esbuild@0.20.1)): + dependencies: + colorette: 2.0.20 + memfs: 3.5.3 + mime-types: 2.1.35 + range-parser: 1.2.1 + schema-utils: 4.2.0 + webpack: 5.90.3(esbuild@0.20.1) + webpack-dev-middleware@6.1.2(webpack@5.90.3(esbuild@0.20.1)): dependencies: colorette: 2.0.20 @@ -36016,7 +36085,7 @@ snapshots: range-parser: 1.2.1 schema-utils: 4.2.0 optionalDependencies: - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) webpack-dev-server@3.11.1(webpack@4.44.2): dependencies: @@ -36098,6 +36167,46 @@ snapshots: - supports-color - utf-8-validate + webpack-dev-server@4.15.1(webpack@5.90.3(esbuild@0.20.1)): + dependencies: + '@types/bonjour': 3.5.12 + '@types/connect-history-api-fallback': 1.5.2 + '@types/express': 4.17.20 + '@types/serve-index': 1.9.3 + '@types/serve-static': 1.15.4 + '@types/sockjs': 0.3.35 + '@types/ws': 8.5.8 + ansi-html-community: 0.0.8 + bonjour-service: 1.1.1 + chokidar: 3.6.0 + colorette: 2.0.20 + compression: 1.7.4(supports-color@6.1.0) + connect-history-api-fallback: 2.0.0 + default-gateway: 6.0.3 + express: 4.18.2(supports-color@6.1.0) + graceful-fs: 4.2.11 + html-entities: 2.4.0 + http-proxy-middleware: 2.0.6(@types/express@4.17.20) + ipaddr.js: 2.1.0 + launch-editor: 2.6.1 + open: 8.4.2 + p-retry: 4.6.2 + rimraf: 3.0.2 + schema-utils: 4.2.0 + selfsigned: 2.4.1 + serve-index: 1.9.1(supports-color@6.1.0) + sockjs: 0.3.24 + spdy: 4.0.2(supports-color@6.1.0) + webpack-dev-middleware: 5.3.3(webpack@5.90.3(esbuild@0.20.1)) + ws: 8.16.0 + optionalDependencies: + webpack: 5.90.3(esbuild@0.20.1) + transitivePeerDependencies: + - bufferutil + - debug + - supports-color + - utf-8-validate + webpack-log@2.0.0: dependencies: ansi-colors: 3.2.4 @@ -36135,17 +36244,10 @@ snapshots: webpack-sources@3.2.3: {} - webpack-subresource-integrity@5.1.0(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.19.11)))(webpack@5.90.3(esbuild@0.20.1)): + webpack-subresource-integrity@5.1.0(html-webpack-plugin@5.5.3)(webpack@5.90.3(esbuild@0.20.1)): dependencies: typed-assert: 1.0.9 - webpack: 5.90.3(esbuild@0.19.11) - optionalDependencies: - html-webpack-plugin: 5.5.3(webpack@5.90.3(esbuild@0.19.11)) - - webpack-subresource-integrity@5.1.0(html-webpack-plugin@5.5.3(webpack@5.90.3(esbuild@0.20.1)))(webpack@5.90.3(esbuild@0.20.1)): - dependencies: - typed-assert: 1.0.9 - webpack: 5.90.3(esbuild@0.19.11) + webpack: 5.90.3(esbuild@0.20.1) optionalDependencies: html-webpack-plugin: 5.5.3(webpack@5.90.3(esbuild@0.19.11)) @@ -36202,7 +36304,38 @@ snapshots: neo-async: 2.6.2 schema-utils: 3.3.0 tapable: 2.2.1 - terser-webpack-plugin: 5.3.10(esbuild@0.19.11)(webpack@5.90.3(esbuild@0.19.11)) + terser-webpack-plugin: 5.3.10(esbuild@0.19.11)(webpack@5.90.3(esbuild@0.20.1)) + watchpack: 2.4.0 + webpack-sources: 3.2.3 + transitivePeerDependencies: + - '@swc/core' + - esbuild + - uglify-js + + webpack@5.90.3(esbuild@0.20.1): + dependencies: + '@types/eslint-scope': 3.7.6 + '@types/estree': 1.0.5 + '@webassemblyjs/ast': 1.11.6 + '@webassemblyjs/wasm-edit': 1.11.6 + '@webassemblyjs/wasm-parser': 1.11.6 + acorn: 8.11.3 + acorn-import-assertions: 1.9.0(acorn@8.11.3) + browserslist: 4.23.0 + chrome-trace-event: 1.0.3 + enhanced-resolve: 5.17.0 + es-module-lexer: 1.5.3 + eslint-scope: 5.1.1 + events: 3.3.0 + glob-to-regexp: 0.4.1 + graceful-fs: 4.2.11 + json-parse-even-better-errors: 2.3.1 + loader-runner: 4.3.0 + mime-types: 2.1.35 + neo-async: 2.6.2 + schema-utils: 3.3.0 + tapable: 2.2.1 + terser-webpack-plugin: 5.3.10(esbuild@0.20.1)(webpack@5.90.3(esbuild@0.20.1)) watchpack: 2.4.0 webpack-sources: 3.2.3 transitivePeerDependencies: diff --git a/scripts/reference-docs.js b/scripts/reference-docs.js new file mode 100644 index 0000000000..d797016f31 --- /dev/null +++ b/scripts/reference-docs.js @@ -0,0 +1,65 @@ +import { resolve } from 'node:path' +import { fileURLToPath } from 'node:url' +import { mkdir, rm } from 'node:fs/promises' +import * as TypeDoc from 'typedoc' + +const __dirname = fileURLToPath(new URL('.', import.meta.url)) + +/** + * @type {Partial} + */ +const options = { + plugin: [ + 'typedoc-plugin-markdown', + resolve(__dirname, './typedoc-remove-prefix.js'), + ], + hideGenerator: true, + readme: 'none', + flattenOutputFiles: true, + entryFileName: 'index', + hideBreadcrumbs: true, + hidePageHeader: true, + useCodeBlocks: true, + excludePrivate: true, +} + +/** @type {Array<{name: string, entryPoints: Array, tsconfig: string, outputDir: string, exclude?: Array}>} */ +const packages = [ + { + name: 'svelte-query', + entryPoints: [resolve(__dirname, '../packages/svelte-query/src/index.ts')], + tsconfig: resolve(__dirname, '../packages/svelte-query/tsconfig.json'), + outputDir: resolve(__dirname, '../docs/framework/svelte/reference'), + exclude: ['./packages/query-core/**/*'], + }, +] + +async function main() { + for (const pkg of packages) { + // Clean and recreate the output directories + try { + await rm(pkg.outputDir, { recursive: true }) + } catch (error) { + // @ts-expect-error + if (error.code !== 'ENOENT') { + throw error + } + } + await mkdir(pkg.outputDir, { recursive: true }) + + const app = await TypeDoc.Application.bootstrapWithPlugins({ + ...options, + entryPoints: pkg.entryPoints, + tsconfig: pkg.tsconfig, + exclude: pkg.exclude, + }) + + const project = await app.convert() + + if (project) { + await app.generateDocs(project, pkg.outputDir) + } + } +} + +main().catch(console.error) diff --git a/scripts/typedoc-remove-prefix.js b/scripts/typedoc-remove-prefix.js new file mode 100644 index 0000000000..f9cfc8d763 --- /dev/null +++ b/scripts/typedoc-remove-prefix.js @@ -0,0 +1,24 @@ +import { MarkdownRendererEvent } from 'typedoc-plugin-markdown' + +/** + * @param {import("typedoc-plugin-markdown").MarkdownApplication} app + */ +export function load(app) { + app.renderer.on( + MarkdownRendererEvent.BEGIN, + /** + * @param {import("typedoc-plugin-markdown").MarkdownRendererEvent} renderer + */ (renderer) => { + renderer.urls = renderer.urls?.map((urlMapping) => { + const name = urlMapping.url.split('.') + if (name[0] !== 'index') { + name.splice(0, 1) + } + const newBasename = name.join('.').toLowerCase() + urlMapping.url = newBasename + urlMapping.model.url = newBasename + return urlMapping + }) + }, + ) +}