nedux-logger/README.md

the next redux state management

# nedux-logger - Debug your nedux store

![typescript](https://img.shields.io/badge/-typescript-blueviolet) [![version](https://img.shields.io/badge/version-beta-blue)](https://www.npmjs.com/package/nedux-logger) [![size](https://img.shields.io/bundlephobia/minzip/nedux-logger?color=green&label=size)](https://www.npmjs.com/package/nedux-logger)

![](./redux-devtools.png)

> The official [middleware](https://github.com/lucasmrdt/nedux#%EF%B8%8F-middlewares) logger for [nedux](https://github.com/lucasmrdt/nedux). Performant and flexible.

## 📦 Installation

```bash
npm install nedux-logger --save
```

**[Install redux Devtool](https://github.com/reduxjs/redux-devtools) or something similar. (like [RN debugger](https://github.com/jhen0409/react-native-debugger))**

## 📜 Documentation

### `Import`

```javascript
// ES6
import { logger } from 'nedux-logger';

// ES5
var logger = require('nedux-logger').logger;
```

### `logger(storeName)`

Create a middleware that allows you to debug your nedux store.

|  argument   | required |   type   | description                                 |
| :---------: | :------: | :------: | :------------------------------------------ |
| `storeName` |    ✅    | `string` | The store name (use to enhance readability) |

## 🎛 Basic Usage

```typescript
import { createStore } from 'nedux';
import { logger } from 'nedux-logger';

type Store = {
  token: string;
  useless: number;
};

const store = createStore<Store>({ token: '', useless: 0 }, logger('my store'));

store.set('token', 'test');
```

## 🙋🏼 Contributions

All [Pull Requests](https://github.com/lucasmrdt/nedux-logger/compare?expand=1), [Issues](https://github.com/lucasmrdt/nedux-logger/issues) and [Discussions](https://github.com/lucasmrdt/nedux-logger/issues) are welcomed !