# vuex-fullstory-plugin

> A logging plugin to output vuex actions to Fullystory.

Latest version **0.2.0** (published 2019-02-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install vuex-fullstory-plugin
pnpm add vuex-fullstory-plugin
yarn add vuex-fullstory-plugin
bun add vuex-fullstory-plugin
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2019-02-17 |
| First published | 2019-02-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 216.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jackson Gross |
| Maintainers | jacksongross |

## Links

- npm: https://www.npmjs.com/package/vuex-fullstory-plugin
- Repository: https://github.com/streemau/vuex-fullstory-plugin
- Issues: https://github.com/streemau/vuex-fullstory-plugin/issues
- npm.io page: https://npm.io/package/vuex-fullstory-plugin

## Recent versions

- 0.2.0 (latest) — 2019-02-17
- 0.1.1 — 2019-02-15

## README

# vuex-fullstory-plugin

A logging plugin to output vuex actions to Fullystory.

## Installation
`npm i --save vuex-fullstory-plugin`

## Usage
Ensure that Fullstory is already loaded in the head of your app. Then simply import/require the `vuex-fullstory-plugin` and configure it with your vuex store:
```js
import createPlugin from 'vuex-fullstory-plugin';

const fullstoryPlugin = createPlugin();

const store = new Vuex.Store({
  // ...
  plugins: [fullstoryPlugin]
});
```

If you'd like to scrub sensitive data from mutations, or prevent some types of mutations from being logged, you can pass a sanitizer function as the second argument to createPlugin.

The sanitizer function should take mutation and return a new object to log. If the sanitizer returns null, the mutation will not be logged.

```js
const fullstoryPlugin = createPlugin(function(mutation) {
  if (mutation.type === 'SET_SECRET_TOKEN') {
    return null;
  }

  return mutation;
})
```

## Getting started
1. Install dependencies
  * Run `yarn install` (recommended) or `npm install` to get the project's dependencies
  * Run `yarn build` or `npm run build` to produce minified version of the library.
2. Development mode
  * Having all the dependencies installed run `yarn dev` or `npm run dev`. This command will generate an non-minified version of the library and will run a watcher so you get the compilation on file change.
3. Running the tests
  * Run `yarn test` or `npm run test`. Can also run in watch mode with `yarn test:watch` or `npm run test:watch`

## Scripts

* `yarn build` or `npm run build` - produces production version of the library under the `lib` folder
* `yarn dev` or `npm run dev` - produces development version of the library and runs a watcher
* `yarn test` or `npm run test` - runs the tests
* `yarn test:watch` or `npm run test:watch` - same as above but in a watch mode
* `npm publish` - publishes a new version of the package to npm.

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