# user-story

> Clientside logger

Latest version **0.0.9** (published 2015-01-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install user-story
pnpm add user-story
yarn add user-story
bun add user-story
```

Provides the command `us`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2015-01-28 |
| First published | 2014-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Artem Golikov |
| Maintainers | piumosso |
| Keywords | UserStory, logger |

## Links

- npm: https://www.npmjs.com/package/user-story
- Repository: https://github.com/piumosso/UserStory
- Issues: https://github.com/piumosso/UserStory/issues
- npm.io page: https://npm.io/package/user-story

## Dependencies (2)

- [commander](https://npm.io/package/commander.md) 2.1.0
- [underscore](https://npm.io/package/underscore.md) *

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.0.9 (latest) — 2015-01-28
- 0.0.8 — 2014-03-24
- 0.0.7 — 2014-03-22
- 0.0.6 — 2014-03-16
- 0.0.5 — 2014-03-15
- 0.0.4 — 2014-03-05
- 0.0.3 — 2014-02-18
- 0.0.2 — 2014-02-13
- 0.0.1 — 2014-02-09

## README

[![Build Status](https://secure.travis-ci.org/piumosso/UserStory.png)](http://travis-ci.org/piumosso/UserStory)
[![Coverage Status](https://coveralls.io/repos/piumosso/UserStory/badge.png)](https://coveralls.io/r/piumosso/UserStory)

[![NPM](https://nodei.co/npm/user-story.png)](https://nodei.co/npm/user-story/)


# UserStory v0.0.9 — client-side logger

![](https://raw.github.com/piumosso/UserStory/master/example/example.png)

### [gulp-user-story](https://github.com/piumosso/gulp-user-story)
### [grunt-user-story](https://github.com/piumosso/grunt-user-story)


## Installation


### Install backend && frontend

```bash
npm install user-story
bower install UserStory
```


### Parse scripts

```bash
cat input.js | ./node_modules/user-story/bin/us > output.js
```


### Include client-side part

```xml
<script type="text/javascript" src="underscore.js"></script>
<script type="text/javascript" src="UserStory.js"></script>
<script type="text/javascript" src="output.js"></script>
```


## Usage


Configure UserStory after script loading:

```xml
<script type="text/javascript" src="bower_components/UserStory/lib/UserStory.js"></script>
<script type="text/javascript">
    UserStory.configure({
        on: ['*'],
        off: ['foo.bar'],
        logger: function (message, section){
            console.log('My custom log', message, section);
        }
    });
</script>
```

or type in console:


```javascript
UserStory.on('*');
```

```javascript
UserStory.off('foo.bar');
```

```javascript
UserStory.reset();
```


```javascript
UserStory.only('foo.bar'); // Equivalent of UserStory.reset(); UserStory.on('foo.bar');
```


### [Пост про UserStory.js](http://piumosso.ru/projects/user-story/userstory-review/)

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