# @types/redux-watch

> TypeScript definitions for redux-watch

Latest version **1.1.2** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/redux-watch
pnpm add @types/redux-watch
yarn add @types/redux-watch
bun add @types/redux-watch
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2023-11-07 |
| First published | 2020-04-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51443 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/redux-watch
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redux-watch
- npm.io page: https://npm.io/package/@types/redux-watch

## Recent versions

- 1.1.2 (latest) — 2023-11-07
- 1.1.0 (ts2.8) — 2020-04-27
- 1.1.1 — 2023-10-18

## README

# Installation
> `npm install --save @types/redux-watch`

# Summary
This package contains type definitions for redux-watch (https://github.com/jprichardson/redux-watch#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redux-watch.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redux-watch/index.d.ts)
````ts
/**
 * This type is suitable to describe path to a field of an object.
 * For details refer
 * @link https://github.com/mariocasciaro/object-path
 */
type FieldPath = string | number | Array<string | number>;

/** Whenever a given state field changes this handler will be called. */
type ChangeHandler<T> = (newValue: T, oldValue: T, pathToField: FieldPath) => void;

/** @see ChangeHandlerWrapper */
type FieldWatch = () => void;

/**
 * @returns Function, that wraps the given change handler in. It should be
 * subscribed to state changes using store.subscribe(). Afterwards, it
 * calls change handler whenever the watched state field changes.
 */
type ChangeHandlerWrapper<T> = (changeHandler: ChangeHandler<T>) => FieldWatch;

/**
 * @param getState Function, that returns the Redux store state.
 * @param pathToField Most commonly dot separated string, or array of strings
 *      and numbers that form path to a field of the state object. For details
 *      refer @link https://github.com/mariocasciaro/object-path
 * @param compare Optional field comparison function. Defaults to strict
 *      equality check (===).
 * @returns Function, that listens to changes of the given field of the Redux store
 *      state. On change it calls its parameter, which is a change handler function.
 */
declare function watch(
    getState: () => any,
    pathToField?: FieldPath,
    compare?: (a: any, b: any) => boolean,
): ChangeHandlerWrapper<any>;

export = watch;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: none

# Credits
These definitions were written by [zoltan.boros](https://github.com/zoltan-boros).

---
_Source: https://npm.io/package/@types/redux-watch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._