Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/framework/angular/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ export class AppComponent {}

**store.ts**
```typescript
import { Store } from '@tanstack/angular-store';
import { createStore } from '@tanstack/angular-store';

// You can instantiate the store outside of Angular components too!
export const store = new Store({
export const store = createStore({
dogs: 0,
cats: 0,
});
Expand Down
8 changes: 4 additions & 4 deletions docs/framework/angular/reference/functions/injectStore.md
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
4 changes: 2 additions & 2 deletions docs/framework/preact/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ The basic preact app example to get started with the TanStack preact-store.

```tsx
import { render } from "preact";
import { Store, useStore } from "@tanstack/preact-store";
import { createStore, useStore } from "@tanstack/preact-store";

// You can instantiate the store outside of Preact components too!
export const store = new Store({
export const store = createStore({
dogs: 0,
cats: 0,
});
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/preact/reference/functions/shallow.md
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
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`
4 changes: 2 additions & 2 deletions docs/framework/react/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ The basic react app example to get started with the TanStack react-store.
```tsx
import React from "react";
import ReactDOM from "react-dom/client";
import { Store, useStore } from "@tanstack/react-store";
import { createStore, useStore } from "@tanstack/react-store";

// You can instantiate the store outside of React components too!
export const store = new Store({
export const store = createStore({
dogs: 0,
cats: 0,
});
Expand Down
8 changes: 4 additions & 4 deletions docs/framework/solid/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ id: quick-start
The basic Solid app example to get started with the TanStack Solid-store.

```jsx
import { Store, useStore } from '@tanstack/solid-store';
import { createStore, useStore } from '@tanstack/solid-store';

// You can instantiate the store outside of Solid components too!
export const store = new Store({
Β  cats: 0,
Β  dogs: 0
export const store = createStore({
cats: 0,
dogs: 0
})

export const Display = (props) => {
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/solid/reference/functions/shallow.md
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
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`\>
4 changes: 2 additions & 2 deletions docs/framework/svelte/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ The basic Svelte app example to get started with the TanStack svelte-store.

**store.ts**
```ts
import { Store } from '@tanstack/svelte-store';
import { createStore } from '@tanstack/svelte-store';

// You can instantiate the store outside of Svelte files too!
export const store = new Store({
export const store = createStore({
dogs: 0,
cats: 0,
});
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/functions/shallow.md
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
Loading