Skip to content

WIP: Integrate XState Store #265

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

Draft
davidkpiano wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

WIP: Integrate XState Store #265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
baeda66
Use XState Store
davidkpiano Dec 12, 2025
b1b75ee
Convert tests
davidkpiano Dec 14, 2025
2866b9f
Angular
davidkpiano Dec 24, 2025
6e09e12
Preact
davidkpiano Dec 24, 2025
f7b36fc
Solid
davidkpiano Dec 24, 2025
76f3443
Svelte
davidkpiano Dec 24, 2025
cae9a74
Vue
davidkpiano Dec 24, 2025
f7b7ee0
Vue (again)
davidkpiano Dec 24, 2025
e9297a5
ci: apply automated fixes and generate docs
autofix-ci[bot] Dec 27, 2025
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
8 changes: 4 additions & 4 deletions docs/framework/angular/reference/functions/injectStore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function injectStore<TState, TSelected>(
options?): Signal<TSelected>;
```

Defined in: [index.ts:19](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L19)
Defined in: [index.ts:21](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L21)

### Type Parameters

Expand All @@ -30,7 +30,7 @@ Defined in: [index.ts:19](https://github.com/TanStack/store/blob/main/packages/a

#### store

`Store`\<`TState`, `any`\>
`Atom`\<`TState`\>

#### selector?

Expand All @@ -53,7 +53,7 @@ function injectStore<TState, TSelected>(
options?): Signal<TSelected>;
```

Defined in: [index.ts:24](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L24)
Defined in: [index.ts:26](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L26)

### Type Parameters

Expand All @@ -69,7 +69,7 @@ Defined in: [index.ts:24](https://github.com/TanStack/store/blob/main/packages/a

#### store

`Derived`\<`TState`, `any`\>
`Atom`\<`TState`\> | `ReadonlyAtom`\<`TState`\>

#### selector?

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/preact/reference/functions/shallow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: shallow
function shallow<T>(objA, objB): boolean;
```

Defined in: [index.ts:130](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L130)
Defined in: [index.ts:121](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L121)

## Type Parameters

Expand Down
67 changes: 13 additions & 54 deletions docs/framework/preact/reference/functions/useStore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,80 +5,39 @@ title: useStore

# Function: useStore()

## Call Signature

```ts
function useStore<TState, TSelected>(
store,
selector?,
options?): TSelected;
```

Defined in: [index.ts:104](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L104)

### Type Parameters

#### TState

`TState`

#### TSelected

`TSelected` = `NoInfer`\<`TState`\>

### Parameters

#### store

`Store`\<`TState`, `any`\>

#### selector?

(`state`) => `TSelected`

#### options?

`UseStoreOptions`\<`TSelected`\>

### Returns

`TSelected`

## Call Signature

```ts
function useStore<TState, TSelected>(
store,
selector?,
options?): TSelected;
selector,
options): TSelected;
```

Defined in: [index.ts:109](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L109)
Defined in: [index.ts:105](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L105)

### Type Parameters
## Type Parameters

#### TState
### TState

`TState`

#### TSelected
### TSelected

`TSelected` = `NoInfer`\<`TState`\>

### Parameters
## Parameters

#### store
### store

`Derived`\<`TState`, `any`\>
`Atom`\<`TState`\> | `ReadonlyAtom`\<`TState`\>

#### selector?
### selector

(`state`) => `TSelected`

#### options?
### options

`UseStoreOptions`\<`TSelected`\>
`UseStoreOptions`\<`TSelected`\> = `{}`

### Returns
## Returns

`TSelected`
2 changes: 1 addition & 1 deletion docs/framework/solid/reference/functions/shallow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: shallow
function shallow<T>(objA, objB): boolean;
```

Defined in: [index.tsx:49](https://github.com/TanStack/store/blob/main/packages/solid-store/src/index.tsx#L49)
Defined in: [index.tsx:39](https://github.com/TanStack/store/blob/main/packages/solid-store/src/index.tsx#L39)

## Type Parameters

Expand Down
65 changes: 12 additions & 53 deletions docs/framework/solid/reference/functions/useStore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,80 +5,39 @@ title: useStore

# Function: useStore()

## Call Signature

```ts
function useStore<TState, TSelected>(
store,
selector?,
options?): Accessor<TSelected>;
selector,
options): Accessor<TSelected>;
```

Defined in: [index.tsx:16](https://github.com/TanStack/store/blob/main/packages/solid-store/src/index.tsx#L16)

### Type Parameters

#### TState

`TState`

#### TSelected

`TSelected` = `NoInfer`\<`TState`\>

### Parameters

#### store

`Store`\<`TState`, `any`\>

#### selector?

(`state`) => `TSelected`

#### options?

`UseStoreOptions`\<`TSelected`\>

### Returns

`Accessor`\<`TSelected`\>

## Call Signature

```ts
function useStore<TState, TSelected>(
store,
selector?,
options?): Accessor<TSelected>;
```

Defined in: [index.tsx:21](https://github.com/TanStack/store/blob/main/packages/solid-store/src/index.tsx#L21)

### Type Parameters
## Type Parameters

#### TState
### TState

`TState`

#### TSelected
### TSelected

`TSelected` = `NoInfer`\<`TState`\>

### Parameters
## Parameters

#### store
### store

`Derived`\<`TState`, `any`\>
`Atom`\<`TState`\> | `ReadonlyAtom`\<`TState`\>

#### selector?
### selector

(`state`) => `TSelected`

#### options?
### options

`UseStoreOptions`\<`TSelected`\>
`UseStoreOptions`\<`TSelected`\> = `{}`

### Returns
## Returns

`Accessor`\<`TSelected`\>
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/functions/shallow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: shallow
function shallow<T>(objA, objB): boolean;
```

Defined in: [index.svelte.ts:51](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L51)
Defined in: [index.svelte.ts:41](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L41)

## Type Parameters

Expand Down
73 changes: 13 additions & 60 deletions docs/framework/svelte/reference/functions/useStore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,91 +5,44 @@ title: useStore

# Function: useStore()

## Call Signature

```ts
function useStore<TState, TSelected>(
store,
selector?,
options?): object;
selector,
options): object;
```

Defined in: [index.svelte.ts:14](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L14)

### Type Parameters

#### TState

`TState`

#### TSelected

`TSelected` = `NoInfer`\<`TState`\>

### Parameters

#### store

`Store`\<`TState`, `any`\>

#### selector?

(`state`) => `TSelected`

#### options?

`UseStoreOptions`\<`TSelected`\>

### Returns

`object`

#### current

```ts
readonly current: TSelected;
```

## Call Signature

```ts
function useStore<TState, TSelected>(
store,
selector?,
options?): object;
```

Defined in: [index.svelte.ts:19](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L19)

### Type Parameters
## Type Parameters

#### TState
### TState

`TState`

#### TSelected
### TSelected

`TSelected` = `NoInfer`\<`TState`\>

### Parameters
## Parameters

#### store
### store

`Derived`\<`TState`, `any`\>
`Atom`\<`TState`\> | `ReadonlyAtom`\<`TState`\>

#### selector?
### selector

(`state`) => `TSelected`

#### options?
### options

`UseStoreOptions`\<`TSelected`\>
`UseStoreOptions`\<`TSelected`\> = `{}`

### Returns
## Returns

`object`

#### current
### current

```ts
readonly current: TSelected;
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/vue/reference/functions/shallow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: shallow
function shallow<T>(objA, objB): boolean;
```

Defined in: [index.ts:55](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L55)
Defined in: [index.ts:45](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L45)

## Type Parameters

Expand Down
Loading