Constructor
new Commented(optionsopt)
Create a CBOR commenter.
- Source:
Parameters:
Name | Type | Attributes | Default | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
any
|
<optional> |
{} |
Stream options
|
Extends
- stream.Transform
Methods
(static) comment(input, options, cbopt) → {Promise}
Comment on an input Buffer or string, creating a string passed to the
callback. If callback not specified, a promise is returned.
- Source:
Parameters:
Name | Type | Attributes | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
input |
string
|
Buffer
|
NoFilter
|
||||||||||||
options |
string
|
Object
|
function
|
|
|||||||||||
cb |
commentCallback
|
<optional> |
Returns:
- Type:
-
Promise
if cb not specified