@coffeekraken/s-stdio

{% extends 'sugar/readme/layouts/main/main.twig' %} {% block body %}

Easy and powerful IO interface

This package allows you to display processes/webpages logs with ease. Here's some of the features available:

• SBasicStdio: Nice IO interface for terminal
• Event based log system
• Filtrable output depending on log type
• Extensible IO system for things like websockets, etc...
• And more...

Usage

Here's how to use our implementation:

import __SStdio from '@coffeekraken/s-stdio';
import spawn from '@coffeekraken/sugar/node/process/spawn';
const proc = spawn('ls -la');
__SStdio.new(__SStdio.UI_BASIC, proc);

How it works

The SStdio class will listen for some events log and ask. Once one of these events is triggered, the IO will either display a log, or the asked question using different implementations depending on the SStdio instanciated type.

The event are listened using the SEventEmitter class.

Here's an example of emitting a log event that will be handled by the SStdio instance:

import __SPromise from '@coffeekraken/s-promise';
import __SLog from '@coffeekraken/s-log';

export default function myProcess() {
    return new __SPromise(({ resolve, reject, emit }) => {
        // do something...
        emit('log', {
            type: __SLog.TYPE_INFO,
            value: 'Hello world from my cool process',
        });
        // do something...
        resolve();
    });
}

Note that the SPromise class extends the SEventEmitter one.

Settings

{% include 'sugar/interface/fromDocmap/fromDocmap.twig' with { docmapItem: docmap.map['@coffeekraken.s-stdio.shared.interface.SStdioSettingsInterface'] } only %}

API

For more information about the API of this class, please check our API documentation

{% endblock %}