Skip to content

Commit

Permalink
ci: apply automated fixes and generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
autofix-ci[bot] authored and crutchcorn committed Nov 30, 2024
1 parent 13c472f commit 8c0e587
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/framework/react/reference/functions/shallow.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ function shallow<T>(objA, objB): boolean

## Defined in

[index.ts:30](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L30)
[index.ts:34](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L34)
44 changes: 35 additions & 9 deletions docs/framework/react/reference/functions/usestore.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,54 @@ title: useStore

# Function: useStore()

## useStore(store, selector)

```ts
function useStore<TState, TSelected, TUpdater>(store, selector): TSelected
function useStore<TState, TSelected>(store, selector): TSelected
```

## Type Parameters
### Type Parameters

**TState**

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

**TUpdater** *extends* `AnyUpdater` = `AnyUpdater`

## Parameters
### Parameters

**store**: `Store`\<`TState`, `TUpdater`\>
**store**: `Store`\<`TState`, `any`\>

**selector** = `...`
**selector**

## Returns
### Returns

`TSelected`

## Defined in
### Defined in

[index.ts:11](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L11)

## useStore(store, selector)

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

### Type Parameters

**TState**

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

### Parameters

**store**: `Derived`\<`TState`, `any`\>

**selector**

### Returns

`TSelected`

### Defined in

[index.ts:15](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L15)

0 comments on commit 8c0e587

Please sign in to comment.