Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noblesamurai/knex-log
Implementation of an abstract-log using knex.
https://github.com/noblesamurai/knex-log
Last synced: about 1 month ago
JSON representation
Implementation of an abstract-log using knex.
- Host: GitHub
- URL: https://github.com/noblesamurai/knex-log
- Owner: noblesamurai
- License: other
- Created: 2017-06-07T04:06:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-07-13T03:54:52.000Z (over 3 years ago)
- Last Synced: 2024-11-16T07:24:50.908Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Knex-log [](http://travis-ci.org/noblesamurai/knex-log) [](http://badges.enytc.com/for/npm/knex-log)
> Implementation of a log using knex.
## Purpose
Implementation of [abstract-log](github.com/eugeneware/abstract-log) using [knex](knexjs.org).
## Usage
```js
const knex = {/* your knex instance */};
const knexLog = require('knex-log')(knex, { tableName: 'tableName' });
```
Now use it like [abstract-log](github.com/eugeneware/abstract-log).
## API
cf [abstract-log](github.com/eugeneware/abstract-log).
## knex-log
- config.tableName - The table which logs are found in.
- config.columnName - The column which logs are found in.
| Param | Type | Description |
| --- | --- | --- |
| knex | Knex | knex instance to use, passed in... |
| config | object | |
* [knex-log](#module_knex-log)
* [~open()](#module_knex-log..open)
* [~close()](#module_knex-log..close)
* [~append(payload)](#module_knex-log..append)
* [~get(offset)](#module_knex-log..get) ⇒ object
* [~createWriteStream()](#module_knex-log..createWriteStream)
* [~createReadStream()](#module_knex-log..createReadStream)
### knex-log~open()
**Kind**: inner method of [knex-log](#module_knex-log)
### knex-log~close()
Call this when done.
**Kind**: inner method of [knex-log](#module_knex-log)
### knex-log~append(payload)
**Kind**: inner method of [knex-log](#module_knex-log)
| Param | Type |
| --- | --- |
| payload | object |
### knex-log~get(offset) ⇒ object
**Kind**: inner method of [knex-log](#module_knex-log)
**Returns**: object - value
| Param | Type |
| --- | --- |
| offset | integer |
### knex-log~createWriteStream()
Create a write stream that we can use to append to the log.
**Kind**: inner method of [knex-log](#module_knex-log)
### knex-log~createReadStream()
- opts.offset.id - The id to read from
**Kind**: inner method of [knex-log](#module_knex-log)
**Params**: object opts
## Installation
This module is installed via npm:
``` bash
$ npm install knex-log
```
## Contributing
### Prerequisites
```
$ pip install pre-commit
```
### Installation
```
$ pre-commit install --install-hooks
```
## License
The BSD License
Copyright (c) 2017, Tim Allen
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
* Neither the name of the Tim Allen nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.