class Hmac
package js.node.crypto
extends Transform › Duplex › Readable › Stream › EventEmitter
Class for creating cryptographic hmac content.
It is a stream that is both readable and writable. The written data is used to compute the hmac.
Once the writable side of the stream is ended, use the read method to get the computed digest.
The legacy update and digest methods are also supported.
Returned by Crypto.createHmac.
Methods
Inherited Variables
Defined by Duplex
read onlywritableEnded:Bool
Is true after writable.end() has been called. This property
does not indicate whether the data has been flushed, for this use
writable.writableFinished instead.
See also:
read onlywritableFinished:Bool
read onlywritableLength:Int
This property contains the number of bytes (or objects) in the queue ready to be written.
The value provides introspection data regarding the status of the highWaterMark.
See also:
read onlywritableObjectMode:Bool
read onlywritablehighWaterMark:Int
Defined by Readable
read onlyisTTY:Bool
Terminal read streams (i.e. process.stdin) have this property set to true. It is false for any other read streams.
See also:
read onlyreadableEncoding:Null<String>
Getter for the property encoding of a given Readable stream.
The encoding property can be set using the readable.setEncoding() method.
See also:
read onlyreadableHighWaterMark:Int
read onlyreadableLength:Int
This property contains the number of bytes (or objects) in the queue ready to be read.
The value provides introspection data regarding the status of the highWaterMark.
See also:
read onlyreadableObjectMode:Bool
Inherited Methods
Defined by Transform
Defined by Duplex
cork():Void
The writable.cork() method forces all written data to be buffered in memory.
The buffered data will be flushed when either the stream.uncork() or stream.end() methods are called.
See also:
destroy(?error:Error):TSelf
Destroy the stream.
Optionally emit an 'error' event, and emit a 'close' event unless emitClose is set in false.
See also:
end(chunk:Dynamic, ?encoding:String, ?callback:EitherType<() ‑> Void, Null<Error> ‑> Void>):Void
end(?callback:EitherType<() ‑> Void, Null<Error> ‑> Void>):Void
Calling the writable.end() method signals that no more data will be written to the Writable.
The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.
If provided, the optional callback function is attached as a listener for the 'finish' event.
See also:
setDefaultEncoding(encoding:String):TSelf
The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.
See also:
uncork():Void
The writable.uncork() method flushes all data buffered since stream.cork() was called.
See also:
write(chunk:Dynamic, ?encoding:String, ?callback:EitherType<() ‑> Void, Null<Error> ‑> Void>):Bool
The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled.
If an error occurs, the callback may or may not be called with the error as its first argument.
To reliably detect write errors, add a listener for the 'error' event.
See also:
Defined by Readable
isPaused():Bool
The readable.isPaused() method returns the current operating state of the Readable.
This is used primarily by the mechanism that underlies the readable.pipe() method.
In most typical cases, there will be no reason to use this method directly.
See also:
pause():TSelf
The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events,
switching out of flowing mode. Any data that becomes available will remain in the internal buffer.
See also:
pipe<T>(destination:T, ?options:{end:Null<Bool>}):T
The readable.pipe() method attaches a Writable stream to the readable,
causing it to switch automatically into flowing mode and push all of its data to the attached Writable.
The flow of data will be automatically managed so that the destination Writable stream
is not overwhelmed by a faster Readable stream.
See also:
read(?size:Int):Null<Dynamic>
The readable.read() method pulls some data out of the internal buffer and returns it.
If no data available to be read, null is returned. By default,
the data will be returned as a Buffer object unless an encoding has been specified using
the readable.setEncoding() method or the stream is operating in object mode.
See also:
resume():TSelf
The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events,
switching the stream into flowing mode.
See also:
setEncoding(encoding:String):TSelf
The readable.setEncoding() method sets the character encoding for data read from the Readable stream.
See also:
unpipe(?destination:IWritable):TSelf
The readable.unpipe() method detaches a Writable stream previously attached using the stream.pipe() method.
See also:
unshift(chunk:Null<Dynamic>, ?encoding:String):Void
Passing chunk as null signals the end of the stream (EOF), after which no more data can be written.
See also:
Defined by EventEmitter
addListener<T>(eventName:Event<T>, listener:T):TSelf
Alias for emitter.on(eventName, listener).
See also:
emit<T>(eventName:Event<T>, args:Rest<Dynamic>):Bool
Synchronously calls each of the listeners registered for the event named
eventName, in the order they were registered, passing the supplied arguments
to each.
See also:
eventNames():Array<EitherType<String, Symbol>>
Returns an array listing the events for which the emitter has registered
listeners. The values in the array will be strings or Symbols.
See also:
getMaxListeners():Int
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to
EventEmitter.defaultMaxListeners.
See also:
listenerCount<T>(eventName:Event<T>):Int
Returns the number of listeners listening to the event named eventName.
See also:
listeners<T>(eventName:Event<T>):Array<T>
Returns a copy of the array of listeners for the event named eventName.
See also:
on<T>(eventName:Event<T>, listener:T):TSelf
Adds the listener function to the end of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName
and listener will result in the listener being added, and called, multiple
times.
See also:
once<T>(eventName:Event<T>, listener:T):TSelf
Adds a one-time listener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.
See also:
prependListener<T>(eventName:Event<T>, listener:T):TSelf
Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName
and listener will result in the listener being added, and called, multiple
times.
See also:
prependOnceListener<T>(eventName:Event<T>, listener:T):TSelf
Adds a one-time listener function for the event named eventName to the
beginning of the listeners array. The next time eventName is triggered, this
listener is removed, and then invoked.
See also:
rawListeners<T>(eventName:Event<T>):Array<T>
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
See also:
removeAllListeners<T>(?eventName:Event<T>):TSelf
Removes all listeners, or those of the specified eventName.
See also:
removeListener<T>(eventName:Event<T>, listener:T):TSelf
Removes the specified listener from the listener array for the event named
eventName.
See also:
setMaxListeners(n:Int):Void
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. Obviously, not all events should be limited to just 10 listeners.
The emitter.setMaxListeners() method allows the limit to be modified for this
specific EventEmitter instance. The value can be set to Infinity (or 0)
to indicate an unlimited number of listeners.
See also: