Knex-log
Implementation of a log using knex.
Purpose
Implementation of abstract-log using knex.
Usage
const knex = /* your knex instance */; const knexLog = knex tableName: 'tableName' ;
Now use it like abstract-log.
API
cf 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~open()
Kind: inner method of knex-log
knex-log~close()
Call this when done.
Kind: inner method of knex-log
knex-log~append(payload)
Kind: inner method of knex-log
Param | Type |
---|---|
payload | object |
object
knex-log~get(offset) ⇒ Kind: inner method of 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
knex-log~createReadStream()
- opts.offset.id - The id to read from
Kind: inner method of knex-log
Params: object
opts
Installation
This module is installed via npm:
$ npm install knex-log
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.