-
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: apply automated fixes and generate docs
- Loading branch information
1 parent
523db77
commit bebe9bc
Showing
27 changed files
with
1,100 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
id: injectStore | ||
title: injectStore | ||
--- | ||
|
||
# Function: injectStore() | ||
|
||
```ts | ||
function injectStore<TState, TSelected, TUpdater>( | ||
store, | ||
selector, | ||
options): Signal<TSelected> | ||
``` | ||
|
||
## Type Parameters | ||
|
||
• **TState** | ||
|
||
• **TSelected** = `NoInfer`\<`TState`\> | ||
|
||
• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater` | ||
|
||
## Parameters | ||
|
||
• **store**: `Store`\<`TState`, `TUpdater`\> | ||
|
||
• **selector** = `...` | ||
|
||
• **options**: `CreateSignalOptions`\<`TSelected`\> & `object` = `...` | ||
|
||
## Returns | ||
|
||
`Signal`\<`TSelected`\> | ||
|
||
## Defined in | ||
|
||
[index.ts:17](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L17) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
id: "@tanstack/angular-store" | ||
title: "@tanstack/angular-store" | ||
--- | ||
|
||
# @tanstack/angular-store | ||
|
||
## Functions | ||
|
||
- [injectStore](functions/injectstore.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
id: shallow | ||
title: shallow | ||
--- | ||
|
||
# Function: shallow() | ||
|
||
```ts | ||
function shallow<T>(objA, objB): boolean | ||
``` | ||
|
||
## Type Parameters | ||
|
||
• **T** | ||
|
||
## Parameters | ||
|
||
• **objA**: `T` | ||
|
||
• **objB**: `T` | ||
|
||
## Returns | ||
|
||
`boolean` | ||
|
||
## Defined in | ||
|
||
[index.ts:30](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L30) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
id: useStore | ||
title: useStore | ||
--- | ||
|
||
# Function: useStore() | ||
|
||
```ts | ||
function useStore<TState, TSelected, TUpdater>(store, selector): TSelected | ||
``` | ||
|
||
## Type Parameters | ||
|
||
• **TState** | ||
|
||
• **TSelected** = `NoInfer`\<`TState`\> | ||
|
||
• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater` | ||
|
||
## Parameters | ||
|
||
• **store**: `Store`\<`TState`, `TUpdater`\> | ||
|
||
• **selector** = `...` | ||
|
||
## Returns | ||
|
||
`TSelected` | ||
|
||
## Defined in | ||
|
||
[index.ts:11](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L11) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
id: "@tanstack/react-store" | ||
title: "@tanstack/react-store" | ||
--- | ||
|
||
# @tanstack/react-store | ||
|
||
## Functions | ||
|
||
- [shallow](functions/shallow.md) | ||
- [useStore](functions/usestore.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
id: useStore | ||
title: useStore | ||
--- | ||
|
||
# Function: useStore() | ||
|
||
```ts | ||
function useStore<TState, TSelected, TUpdater>(store, selector): Accessor<TSelected> | ||
``` | ||
|
||
## Type Parameters | ||
|
||
• **TState** | ||
|
||
• **TSelected** = `NoInfer`\<`TState`\> | ||
|
||
• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater` | ||
|
||
## Parameters | ||
|
||
• **store**: `Store`\<`TState`, `TUpdater`\> | ||
|
||
• **selector** = `...` | ||
|
||
## Returns | ||
|
||
`Accessor`\<`TSelected`\> | ||
|
||
## Defined in | ||
|
||
[index.tsx:13](https://github.com/TanStack/store/blob/main/packages/solid-store/src/index.tsx#L13) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
id: "@tanstack/solid-store" | ||
title: "@tanstack/solid-store" | ||
--- | ||
|
||
# @tanstack/solid-store | ||
|
||
## Functions | ||
|
||
- [useStore](functions/usestore.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
id: shallow | ||
title: shallow | ||
--- | ||
|
||
# Function: shallow() | ||
|
||
```ts | ||
function shallow<T>(objA, objB): boolean | ||
``` | ||
|
||
## Type Parameters | ||
|
||
• **T** | ||
|
||
## Parameters | ||
|
||
• **objA**: `T` | ||
|
||
• **objB**: `T` | ||
|
||
## Returns | ||
|
||
`boolean` | ||
|
||
## Defined in | ||
|
||
[index.svelte.ts:39](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L39) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
id: useStore | ||
title: useStore | ||
--- | ||
|
||
# Function: useStore() | ||
|
||
```ts | ||
function useStore<TState, TSelected, TUpdater>(store, selector): object | ||
``` | ||
|
||
## Type Parameters | ||
|
||
• **TState** | ||
|
||
• **TSelected** = `NoInfer`\<`TState`\> | ||
|
||
• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater` | ||
|
||
## Parameters | ||
|
||
• **store**: `Store`\<`TState`, `TUpdater`\> | ||
|
||
• **selector** = `...` | ||
|
||
## Returns | ||
|
||
`object` | ||
|
||
### current | ||
|
||
#### Get Signature | ||
|
||
```ts | ||
get current(): TSelected | ||
``` | ||
|
||
##### Returns | ||
|
||
`TSelected` | ||
|
||
## Defined in | ||
|
||
[index.svelte.ts:10](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L10) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
id: "@tanstack/svelte-store" | ||
title: "@tanstack/svelte-store" | ||
--- | ||
|
||
# @tanstack/svelte-store | ||
|
||
## Functions | ||
|
||
- [shallow](functions/shallow.md) | ||
- [useStore](functions/usestore.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
id: shallow | ||
title: shallow | ||
--- | ||
|
||
# Function: shallow() | ||
|
||
```ts | ||
function shallow<T>(objA, objB): boolean | ||
``` | ||
|
||
## Type Parameters | ||
|
||
• **T** | ||
|
||
## Parameters | ||
|
||
• **objA**: `T` | ||
|
||
• **objB**: `T` | ||
|
||
## Returns | ||
|
||
`boolean` | ||
|
||
## Defined in | ||
|
||
[index.ts:43](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L43) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
id: useStore | ||
title: useStore | ||
--- | ||
|
||
# Function: useStore() | ||
|
||
```ts | ||
function useStore<TState, TSelected, TUpdater>(store, selector): Readonly<Ref<TSelected>> | ||
``` | ||
|
||
## Type Parameters | ||
|
||
• **TState** | ||
|
||
• **TSelected** = `NoInfer`\<`TState`\> | ||
|
||
• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater` | ||
|
||
## Parameters | ||
|
||
• **store**: `Store`\<`TState`, `TUpdater`\> | ||
|
||
• **selector** = `...` | ||
|
||
## Returns | ||
|
||
`Readonly`\<`Ref`\<`TSelected`\>\> | ||
|
||
## Defined in | ||
|
||
[index.ts:12](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L12) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
id: "@tanstack/vue-store" | ||
title: "@tanstack/vue-store" | ||
--- | ||
|
||
# @tanstack/vue-store | ||
|
||
## Functions | ||
|
||
- [shallow](functions/shallow.md) | ||
- [useStore](functions/usestore.md) |
Oops, something went wrong.