https://github.com/eik-lib/sink-memory
An in-memory Sink implementation for use in automated tests
https://github.com/eik-lib/sink-memory
eik eik-sink
Last synced: about 2 months ago
JSON representation
An in-memory Sink implementation for use in automated tests
- Host: GitHub
- URL: https://github.com/eik-lib/sink-memory
- Owner: eik-lib
- License: mit
- Created: 2024-07-23T12:57:29.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T11:31:23.000Z (2 months ago)
- Last Synced: 2025-04-04T02:18:15.001Z (2 months ago)
- Topics: eik, eik-sink
- Language: JavaScript
- Homepage: https://eik.dev
- Size: 45.9 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @eik/sink-memory
A Sink implementation that runs completely in memory, designed for automated tests.
## Usage
```sh
npm install @eik/sink-memory
```
```js
import { pipeline } from 'node:stream';
import express from 'express';
import Sink from '@eik/sink-memory';
const app = express();
const sink = new Sink();
app.get('/file.js', async (req, res, next) => {
try {
const file = await sink.read('/path/to/file/file.js');
pipeline(file.stream, res, (error) => {
if (error) return next(error);
});
} catch (error) {
next(error);
}
});
app.listen(8000);
```
## API
The sink instance has the following API:
### .write(filePath, contentType)
Method for writing a file to in-memory storage.
This method takes the following arguments:
- `filePath` - String - Path to the file to be stored - Required.
- `contentType` - String - The content type of the file - Required.
Resolves with a writable stream.
```js
import { pipeline } from 'node:stream';
const fromStream = new SomeReadableStream();
const sink = new Sink({ ... });
try {
const file = await sink.write('/path/to/file/file.js', 'application/javascript');
pipeline(fromStream, file.stream, (error) => {
if (error) console.log(error);
});
} catch (error) {
console.log(error);
}
```
### .read(filePath)
Method for reading a file from storage.
This method takes the following arguments:
- `filePath` - String - Path to the file to be read - Required.
Resolves with a [ReadFile][read-file] object which holds metadata about
the file and a readable stream with the byte stream of the file on the
`.stream` property.
```js
import { pipeline } from 'node:stream';
const toStream = new SomeWritableStream();
const sink = new Sink({ ... });
try {
const file = await sink.read('/path/to/file/file.js');
pipeline(file.stream, toStream, (error) => {
if (error) console.log(error);
});
} catch (error) {
console.log(error);
}
```
### .delete(filePath)
Method for deleting a file in storage.
This method takes the following arguments:
- `filePath` - String - Path to the file to be deleted - Required.
Resolves if file is deleted and rejects if file could not be deleted.
```js
const sink = new Sink({ ... });
try {
await sink.delete('/path/to/file/file.js');
} catch (error) {
console.log(error);
}
```
### .exist(filePath)
Method for checking if a file exist in the storage.
This method takes the following arguments:
- `filePath` - String - Path to the file to be checked for existence - Required.
Resolves if file exists and rejects if file does not exist.
```js
const sink = new Sink({ ... });
try {
await sink.exist('/path/to/file/file.js');
} catch (error) {
console.log(error);
}
```
[eik]: https://github.com/eik-lib
[read-file]: https://github.com/eik-lib/common/blob/master/lib/classes/read-file.js