Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zoubin/tick-node
Print the tick number in debug mode
https://github.com/zoubin/tick-node
Last synced: 8 days ago
JSON representation
Print the tick number in debug mode
- Host: GitHub
- URL: https://github.com/zoubin/tick-node
- Owner: zoubin
- License: mit
- Created: 2016-01-06T11:43:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-08T14:46:09.000Z (almost 9 years ago)
- Last Synced: 2024-10-04T07:49:10.922Z (about 2 months ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tick-node
[](https://www.npmjs.org/package/tick-node)
[](https://travis-ci.org/zoubin/tick-node)
Print the tick number in debug mode.
## Usage
### Command line
```bash
npm install -g tick-node
tick-node -V
```
[example/cli.js](example/cli.js):
```js
var n = 3
var rs = require('stream').Readable({
read: function () {
process.nextTick(function (prefix) {
if (n) {
rs.push(prefix + n-- + '\n')
} else {
rs.push(null)
}
}, 'DATA: ')
},
})
rs.pipe(process.stdout)
```
**Output**:
```
⌘ NODE_DEBUG=stream tick-node example/cli.js
STREAM 59690: pipe count=1 opts=undefined
STREAM 59690: resume
---------- TICK 1 ----------
STREAM 59690: resume read 0
STREAM 59690: read 0
STREAM 59690: need readable false
STREAM 59690: length less than watermark true
STREAM 59690: do read
STREAM 59690: flow true
STREAM 59690: read undefined
STREAM 59690: need readable true
STREAM 59690: length less than watermark true
STREAM 59690: reading or ended false
---------- TICK 2 ----------
STREAM 59690: ondata
DATA: 3
STREAM 59690: read 0
STREAM 59690: need readable true
STREAM 59690: length less than watermark true
STREAM 59690: do read
---------- TICK 3 ----------
STREAM 59690: ondata
DATA: 2
STREAM 59690: read 0
STREAM 59690: need readable true
STREAM 59690: length less than watermark true
STREAM 59690: do read
---------- TICK 4 ----------
STREAM 59690: ondata
DATA: 1
STREAM 59690: read 0
STREAM 59690: need readable true
STREAM 59690: length less than watermark true
STREAM 59690: do read
---------- TICK 5 ----------
STREAM 59690: emitReadable true
STREAM 59690: emit readable
STREAM 59690: flow true
STREAM 59690: read undefined
---------- TICK 6 ----------
STREAM 59690: cleanup
---------- TICK 7 ----------
```
### API
[example/api.js](example/api.js):
```js
require('tick-node').polyfill()
var n = 3
var rs = require('stream').Readable({
read: function () {
process.nextTick(function (prefix) {
if (n) {
rs.push(prefix + n-- + '\n')
} else {
rs.push(null)
}
}, 'DATA: ')
},
})
rs.pipe(process.stdout)
```
**Output**
```
⌘ NODE_DEBUG=stream,nexttick node example/api.js
STREAM 59678: pipe count=1 opts=undefined
STREAM 59678: resume
---------- TICK 1 ----------
STREAM 59678: resume read 0
STREAM 59678: read 0
STREAM 59678: need readable false
STREAM 59678: length less than watermark true
STREAM 59678: do read
STREAM 59678: flow true
STREAM 59678: read undefined
STREAM 59678: need readable true
STREAM 59678: length less than watermark true
STREAM 59678: reading or ended false
---------- TICK 2 ----------
STREAM 59678: ondata
DATA: 3
STREAM 59678: read 0
STREAM 59678: need readable true
STREAM 59678: length less than watermark true
STREAM 59678: do read
---------- TICK 3 ----------
STREAM 59678: ondata
DATA: 2
STREAM 59678: read 0
STREAM 59678: need readable true
STREAM 59678: length less than watermark true
STREAM 59678: do read
---------- TICK 4 ----------
STREAM 59678: ondata
DATA: 1
STREAM 59678: read 0
STREAM 59678: need readable true
STREAM 59678: length less than watermark true
STREAM 59678: do read
---------- TICK 5 ----------
STREAM 59678: emitReadable true
STREAM 59678: emit readable
STREAM 59678: flow true
STREAM 59678: read undefined
---------- TICK 6 ----------
STREAM 59678: cleanup
---------- TICK 7 ----------
```
## API
```js
require('tick-node').polyfill()
```
### polyfill(options)
`process.nextTick` will be hacked to print tick info.
**options.color**
Specify whether print colorful splitters.
Type: `Boolean`