# asset-pipe-sink-mem

> Module for writing and reading asset feeds and js/css bundles to and from a simple in memory store

Latest version **1.0.0-beta.5** (published 2017-06-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install asset-pipe-sink-mem
pnpm add asset-pipe-sink-mem
yarn add asset-pipe-sink-mem
bun add asset-pipe-sink-mem
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-beta.5 |
| Published | 2017-06-26 |
| First published | 2017-04-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Trygve Lie |
| Maintainers | trygve |
| Keywords | test |

## Links

- npm: https://www.npmjs.com/package/asset-pipe-sink-mem
- Repository: https://github.com/asset-pipe/asset-pipe-sink-mem
- Homepage: https://github.com/asset-pipe/asset-pipe-sink-mem#readme
- Issues: https://github.com/asset-pipe/asset-pipe-sink-mem/issues
- npm.io page: https://npm.io/package/asset-pipe-sink-mem

## Dependencies (4)

- [JSONStream](https://npm.io/package/JSONStream.md) 1.3.1
- [concat-stream](https://npm.io/package/concat-stream.md) 1.6.0
- [readable-stream](https://npm.io/package/readable-stream.md) 2.3.2
- [asset-pipe-common](https://npm.io/package/asset-pipe-common.md) 1.0.0-beta.6

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 1.0.0-beta.5 (latest) — 2017-06-26
- 1.0.0-beta.4 — 2017-04-27
- 1.0.0-beta.3 — 2017-04-24
- 1.0.0-beta.2 — 2017-04-24
- 1.0.0-beta.1 — 2017-04-20

## README

# asset-pipe-sink-mem

[![Greenkeeper badge](https://badges.greenkeeper.io/asset-pipe/asset-pipe-sink-mem.svg)](https://greenkeeper.io/)

A [asset-pipe][asset-pipe] sink for writing and reading asset feeds and js/css bundles to and from a
simple in memory store.

The intention of the [asset-pipe][asset-pipe] sink modules is to use be able to write and read files
to different backends by just swapping modules. By each sink implementing the same public API it is
possible to ex use this module in one environment and another sink module in another environment.

These sinks are normally used by the [asset-pipe-build-server][asset-pipe-build-server].



## Installation

```bash
$ npm install asset-pipe-sink-mem
```



## Example

Read an asset feed from the store and serve it on http:

```js
const express = require('express');
const Sink = require('asset-pipe-sink-mem');

const app = express();
const sink = new Sink();

app.get('/', (req, res, next) => {
    const file = sink.reader('feed.json');
    file.on('file not found', () => {
        res.status(404).send('File not found');
    });
    file.on('file found', () => {
        res.status(200);
        file.pipe(res);
    });
});

app.listen(8000);
```



## API

This module have the following API:

### constructor()

Constructor takes no arguments.

### writer(type)

Method for writing a file to memory. Returns a write stream.

Supported arguments are:

 - `type` - String - File type of the file to write. Used as extension of the persisted file. - Required

Events:

 - `file saved` - When a file have been sucessfully persisted. Emits with: `id` and `file`.
 - `file not saved` -  When a file could not be persisted. Emits with: `error`.
 - `error` -  When an error occured during persistence. Emits with: `error`.


### reader(file)

Method for reading a file from memory. Returns a read stream.

Supported arguments are:

 - `file` - String - File name of the file to read. - Required

Events:

 - `file found` - When the file we want to read is found. Emits with: `file`.
 - `file not saved` -  When the file we want to read is not found. Emits with: `file`.



## License

The MIT License (MIT)

Copyright (c) 2017 - Trygve Lie - post@trygve-lie.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.



[asset-pipe]: https://github.com/asset-pipe
[asset-pipe-build-server]: https://github.com/asset-pipe/asset-pipe-build-server

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