https://github.com/eik-lib/sink
The storage sink interface used by Eik
https://github.com/eik-lib/sink
eik eik-sink
Last synced: 12 months ago
JSON representation
The storage sink interface used by Eik
- Host: GitHub
- URL: https://github.com/eik-lib/sink
- Owner: eik-lib
- Created: 2020-04-17T10:05:14.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-07-01T06:26:43.000Z (about 1 year ago)
- Last Synced: 2025-07-01T07:29:09.467Z (about 1 year ago)
- Topics: eik, eik-sink
- Language: JavaScript
- Homepage: https://eik.dev
- Size: 123 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# @eik/sink
A sink interface defining the public sink API in Eik.
[](https://david-dm.org/eik-lib/sink)
[](https://github.com/eik-lib/sink/actions?query=workflow%3A%22Run+Lint+and+Tests%22)
[](https://snyk.io/test/github/eik-lib/sink?targetFile=package.json)
The intention of the [Eik][eik] sink modules is to be able to write to and read from
files in different storage backends by swapping sink modules. Because each sink
implements the same public API it is possible to use this sink in one environment and
another sink in a different environment. This is an interface containing the
public API each sink has to implement.
## Installation
```bash
$ npm install @eik/sink
```
## Example
Implement a custom sink:
```js
const { ReadFile } = require('@eik/common');
const Sink = require('@eik/sink');
const SinkCustom = class SinkCustom extends Sink {
constructor() {
super();
}
write(filePath, contentType) {
return new Promise((resolve, reject) => {
try {
super.constructor.validateFilePath(filePath);
super.constructor.validateContentType(contentType);
} catch (error) {
reject(error);
return;
}
// Custom code
resolve();
});
}
read(filePath) {
return new Promise((resolve, reject) => {
try {
super.constructor.validateFilePath(filePath);
} catch (error) {
reject(error);
return;
}
// Custom code
const obj = new ReadFile();
resolve(obj);
});
}
delete(filePath) {
return new Promise((resolve, reject) => {
try {
super.constructor.validateFilePath(filePath);
} catch (error) {
reject(error);
return;
}
// Custom code
resolve();
});
}
exist(filePath) {
return new Promise((resolve, reject) => {
try {
super.constructor.validateFilePath(filePath);
} catch (error) {
reject(error);
return;
}
// Custom code
resolve();
});
}
get metrics() {
return // Custom metric stream code
}
get [Symbol.toStringTag]() {
return 'SinkCustom';
}
}
```
## License
Copyright (c) 2020 FINN.no
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.
[eik]: https://github.com/eik-lib