Class: Commented

Defined in:	src/commented.coffee
Inherits:	stream.Transform

Overview

Generate the expanded format of RFC 7049, section 2.2.1

Class Method Summary

. (void) comment(input, options, cb) Comment on an input Buffer or string, creating a string passed to the callback.

Class Method Details

. (void) comment(input, options, cb)

Comment on an input Buffer or string, creating a string passed to the callback. If callback not specified, output goes to stdout.

Parameters:

input ( Buffer,String,NoFilter ) — input
max_depth ( Integer ) — how many times to indent the dashes (default: 10)
cb ( function(Error, String) ) — optional.

Constructor Details

# (void) constructor(options = {})

Create a CBOR commenter.

Parameters:

options ( Object ) — options for the parser

Options Hash: (options):

max_depth ( Integer ) — how many times to indent the dashes (default: 10)

Quickly fuzzy find classes, mixins, methods, file:

T Open fuzzy finder dialog

Control the navigation frame:

L Toggle list view
C Show class list
I Show mixin list
F Show file list
M Show method list
E Show extras list

You can focus and blur the search input:

S Focus search input
Esc Blur search input