/sore

Shell core functions

Primary LanguageJavaScript

sore

The package name "sore" may be interpreted as character-reversed "Eros" who is "the Greek god of sensual love and desire". Another way to remember the name is to regard it as the combination of "shell" and "core". This is my way!

Shell Core

This package is a collection. Depending on this package, you may develop in Node.js with APIs which offer functions similiar with basic / frequently-used *nix commands.

Table of Contents

Get Start

Require all sub-modules at once.

const sore = require('sore');

sore.find({
	basepath: '/var/log',
	type: 'd',
}, (err, data) => {
	// ...
});

Or, require specified sub module directly.

const find = require('sore/find');

find({
	basepath: '/var/log',
	type: 'd',
}, (err, data) => {
	// ...
});

API

Most of sub modules are designed to be asynchronous and conform to PoC pattern. Here are available sub modules：

References