Giter VIP home page Giter VIP logo

noflo-handyman's Introduction

Handy tools for debugging
Build Status Dependency Status NPM version Stories in Ready

This package provides various components to drop-in debugging in NoFlo.

Feel free to contribute new components and graphs! I'll try to incorporate as soon as time allows.

Usage

Quit

Quit the Node.js process.

In-ports

  • IN: everything is dropped and call process.exit upon disconnect.

Out-ports

  • OUT: no data packets are emitted. This is simply here for drop-in use of this component.

Examples

Quit the process.

'whatever' -> IN Quit(handyman/Quit) OUT -> IN NotReceivingIt(core/Output)

Log

Output all connect, begingroup, data, endgroup, and disconnect signals to screen in a formatted manner. Because NoFlo passes packets of all kinds immediately for performance (i.e. all the begingroups would be emitted before the data packets enclosed by the begingroups are emitted), The entire stream of packets passing through a particular process isn't conclusive until all packets are sent.

Therefore, if you place an 'Output' component after a 'Log' component, data packets passing through 'Output' will always be displayed on screen before anything emitted from/to the 'Log' component is displayed. However, 'Log' displays all packets in the appropriate order when other 'Log' processes are involved.

'Log' also distinguishes between "streams". A packet passing through two distinct 'Log' processes share a stream when it passes the processes before the whole flow of packets completes. For instance,

'X' -> IN A(handyman/Log) OUT -> IN Repeat(core/Repeat) OUT -> IN B(handyman/Log)

'X' is displayed twice because it passes through both processes 'A' and 'B' and it is grouped in a single stream. However, if...

'Y' -> IN A(handyman/Log) OUT -> IN Repeat(core/RepeatAsync) OUT -> IN B(handyman/Log)

'Y' is still displayed twice becauses it passes through the two processes but it's displayed separately in two streams because there is an asynchronous operation in the middle and the flow completes at the 'Repeat' process.

In-ports

  • IN: anything that will be displayed on screen.
  • OPTIONS: an object to be passed to util.inspect

Out-ports

  • OUT: if attached, everything from 'IN' will be forwarded to this port.

Examples

Print:

------------ STREAM ------------
-
-       CONNECT | 
-    BEGINGROUP | Group
-          DATA | 'Data'
-      ENDGROUP | Group
-    DISCONNECT | 
-
-       CONNECT | 
-    BEGINGROUP | Group
-          DATA | 'Data'
-      ENDGROUP | Group
-    DISCONNECT | 
-
--------------------------------
'Group' -> GROUP Group(core/Group)
'Data' -> IN Group() OUT -> IN A(handyman/Log) OUT -> IN Repeat(core/Repeat) OUT -> IN B(handyman/Log)

Print:

------------ STREAM ------------
-
-       CONNECT | 
-    BEGINGROUP | Group
-          DATA | 'Data'
-      ENDGROUP | Group
-    DISCONNECT | 
-
--------------------------------
-
-
------------ STREAM ------------
-
-       CONNECT | 
-    BEGINGROUP | Group
-          DATA | 'Data'
-      ENDGROUP | Group
-    DISCONNECT | 
-
--------------------------------
'Group' -> GROUP Group(core/Group)
'Data' -> IN Group() OUT -> IN A(handyman/Log) OUT -> IN RepeatAsync(core/RepeatAsync) OUT -> IN B(handyman/Log)

noflo-handyman's People

Contributors

kenhkan avatar larskluge avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.