0.1.3 • Published 3 years ago

klp-core v0.1.3

Weekly downloads
89
License
MIT
Repository
github
Last release
3 years ago

TODO: klp-core teaser

:horse:klp-core is a plugin with basic operations for klp (Kelpie), the small, fast, and magical command-line data processor.

See the klp github repository for more details!

node version npm version license PRs Welcome linux unit tests status macos unit tests status windows unit tests status

Installation

:ok_hand: klp-core comes preinstalled in klp. No installation necessary. If you still want to install it, proceed as described below.

klp-core is installed in ~/.klp/ as follows:

npm install klp-core

The plugin is included in ~/.klp/index.js as follows:

const core = require('klp-core')

module.exports = {
  plugins:  [core],
  context:  {},
  defaults: {}
}

For a much more detailed description, see the .klp module documentation.

Extensions

This plugin comes with the following klp extensions:

Description
line chunkerDivides data on line breaks. A lot of data formats like CSV, TSV, and JSON line build on this separation.
map applierApplies klp's functions to each individual line. Always returns a single result, unless an error is thrown during function application.
flatMap applierApplies klp's functions to each individual line. May return any number of results, including none, thus being able to change the length of a file.
filter applierTreats klp's functions as a conjunction of predicates and applies it to each individual line. If any predicate is false, the line is dropped, if all predicates return true, the line is kept.
string serializerSerializes each transformed JSON into a string separated by newlines.

Reporting Issues

Please report issues in the tracker!

License

klp-core is MIT licensed.