Documentation

Class: Commented

Commented

new Commented()

Generate the expanded format of RFC 7049, section 2.2.1

Extends

  • stream.Transform

Classes

Commented

Methods

<static> comment(input, options [, cb])

Comment on an input Buffer or string, creating a string passed to the callback. If callback not specified, a promise is returned.
Parameters:
Name Type Argument Description
input string | Buffer | NoFilter
options string | object | function
Properties
Name Type Argument Default Description
max_depth number <optional>
 10 how many times to indent the dashes
cb commentCallback <optional>
Returns:
if cb not specified
Type
Promise