trait Sign extends Object with Duplex
The Sign Class is a utility for generating signatures. It can be used in one of two ways:
- As a writable stream, where data to be signed is written and the sign.sign() method is used to generate and return the signature, or
- Using the sign.update() and sign.sign() methods to produce the signature.
The crypto.createSign() method is used to create Sign instances. Sign objects are not to be created directly using the new keyword.
- Annotations
- @RawJSType() @native()
- Alphabetic
- By Inheritance
- Sign
- Duplex
- Writable
- Readable
- IEventEmitter
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
_read: Function0[Any]
- Definition Classes
- Readable
-
def
addListener(eventName: String, listener: Function): Sign.this.type
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
- Definition Classes
- IEventEmitter
emitter.addListener(eventName, listener)
- See also
on()
Example: -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
cork(): Unit
Forces buffering of all writes.
Forces buffering of all writes. Buffered data will be flushed either at stream.uncork() or at stream.end() call.
- Definition Classes
- Writable
writable.cork()
Example: -
val
domain: String
- Definition Classes
- IEventEmitter
-
def
emit(name: String, args: Any*): Any
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Returns true if the event had listeners, false otherwise.
- name
the event name
- args
the event arguments
- Definition Classes
- IEventEmitter
emitter.emit(name[, arg1][, arg2][, ...])
Example: -
def
end(): Unit
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
- Definition Classes
- Writable
writable.end([chunk][, encoding][, callback])
Example: -
def
end(callback: Function): Unit
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
- callback
the Callback for when this chunk of data is flushed
- Definition Classes
- Writable
writable.end([chunk][, encoding][, callback])
Example: -
def
end(chunk: |[String, Buffer], callback: Function): Unit
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
- chunk
The data to write (<String> | <Buffer>)
- callback
the Callback for when this chunk of data is flushed
- Definition Classes
- Writable
writable.end([chunk][, encoding][, callback])
Example: -
def
end(chunk: |[String, Buffer], encoding: String = js.native): Unit
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
- chunk
The data to write (<String> | <Buffer>)
- encoding
The encoding, if chunk is a String
- Definition Classes
- Writable
writable.end([chunk][, encoding][, callback])
Example: -
def
end(chunk: |[String, Buffer], encoding: String, callback: Function): Unit
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
- chunk
The data to write (<String> | <Buffer>)
- encoding
The encoding, if chunk is a String
- callback
the Callback for when this chunk of data is flushed
- Definition Classes
- Writable
writable.end([chunk][, encoding][, callback])
Example: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getMaxListeners(): Int
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
- Definition Classes
- IEventEmitter
emitter.getMaxListeners()
- See also
setMaxListeners()
Example: -
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPaused(): Boolean
This method returns whether or not the readable has been explicitly paused by client code (using stream.pause() without a corresponding stream.resume()).
This method returns whether or not the readable has been explicitly paused by client code (using stream.pause() without a corresponding stream.resume()).
- Definition Classes
- Readable
readable.isPaused()
Example: -
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
def
listenerCount(eventName: String): Int
Returns the number of listeners listening to the event named eventName.
Returns the number of listeners listening to the event named eventName.
- Definition Classes
- IEventEmitter
emitter.listenerCount(eventName)
Example: -
def
listeners(eventName: String): Array[Function]
Returns a copy of the array of listeners for the event named eventName.
Returns a copy of the array of listeners for the event named eventName.
- Definition Classes
- IEventEmitter
emitter.listeners(eventName)
Example: -
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
on(eventName: String, listener: Function): Sign.this.type
Adds the listener function to the end of the listeners array for the event named eventName.
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.
Returns a reference to the EventEmitter so calls can be chained.
- Definition Classes
- IEventEmitter
emitter.on(eventName, listener)
Example: -
def
once(eventName: String, listener: Function): Sign.this.type
Adds a one time listener function for the event named eventName.
Adds a one time listener function for the event named eventName. This listener is invoked only the next time eventName is triggered, after which it is removed.
- Definition Classes
- IEventEmitter
emitter.once(eventName, listener)
Example: -
def
pause(): Sign.this.type
This method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode.
This 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.
- Definition Classes
- Readable
readable.pause()
Example: -
def
pipe(destination: Writable, options: RawOptions = js.native): Sign.this.type
This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.
This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream. Multiple destinations can be piped to safely.
- Definition Classes
- Readable
readable.pipe(destination[, options])
Example: -
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
def
push(value: Any): Sign.this.type
TODO find documentation for this method
TODO find documentation for this method
- Definition Classes
- Readable
-
def
read[T](size: Int = js.native): T
The read() method pulls some data out of the internal buffer and returns it.
The read() method pulls some data out of the internal buffer and returns it. If there is no data available, then it will return null.
If you pass in a size argument, then it will return that many bytes. If size bytes are not available, then it will return null, unless we've ended, in which case it will return the data remaining in the buffer.
If you do not specify a size argument, then it will return all the data in the internal buffer.
This method should only be called in paused mode. In flowing mode, this method is called automatically until the internal buffer is drained.
- Definition Classes
- Readable
readable.read([size])
Example: -
def
removeAllListeners(): Sign.this.type
Removes all listeners, or those of the specified eventName.
Removes all listeners, or those of the specified eventName.
Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter so calls can be chained.
- Definition Classes
- IEventEmitter
emitter.removeAllListeners([eventName])
Example: -
def
removeAllListeners(eventName: String): Sign.this.type
Removes all listeners, or those of the specified eventName.
Removes all listeners, or those of the specified eventName.
Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter so calls can be chained.
- Definition Classes
- IEventEmitter
emitter.removeAllListeners([eventName])
Example: -
def
removeListener(eventName: String, listener: Function): Sign.this.type
Removes the specified listener from the listener array for the event named eventName.
Removes the specified listener from the listener array for the event named eventName. removeListener will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener must be called multiple times to remove each instance.
Note that once an event has been emitted, all listeners attached to it at the time of emitting will be called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events will behave as expected.
- Definition Classes
- IEventEmitter
emitter.removeListener(eventName, listener)
Example: -
def
resume(): Sign.this.type
This method will cause the readable stream to resume emitting 'data' events.
This method will cause the readable stream to resume emitting 'data' events. This method will switch the stream into flowing mode. If you do not want to consume the data from a stream, but you do want to get to its 'end' event, you can call stream.resume() to open the flow of data.
- Definition Classes
- Readable
readable.resume()
Example: -
def
setDefaultEncoding(encoding: String): Sign.this.type
Sets the default encoding for a writable stream.
Sets the default encoding for a writable stream.
- Definition Classes
- Writable
writable.setDefaultEncoding(encoding)
Example: -
def
setEncoding(encoding: String): Sign.this.type
Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects.
Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects. For example, if you do readable.setEncoding('utf8'), then the output data will be interpreted as UTF-8 data, and returned as strings. If you do readable.setEncoding('hex'), then the data will be encoded in hexadecimal string format.
This properly handles multi-byte characters that would otherwise be potentially mangled if you simply pulled the Buffers directly and called buf.toString(encoding) on them. If you want to read the data as strings, always use this method.
Also you can disable any encoding at all with readable.setEncoding(null). This approach is very useful if you deal with binary data or with large multi-byte strings spread out over multiple chunks.
- Definition Classes
- Readable
readable.setEncoding(encoding)
Example: -
def
setMaxListeners(n: Int): Sign.this.type
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event.
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) for to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter so calls can be chained.
- Definition Classes
- IEventEmitter
emitter.setMaxListeners(n)
Example: - def sign(private_key: String, output_format: String): String
- def sign(private_key: String): String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
uncork(): Unit
Flush all data, buffered since stream.cork() call.
Flush all data, buffered since stream.cork() call.
- Definition Classes
- Writable
writable.uncork()
Example: -
def
unpipe(destination: Writable = js.native): Unit
This method will remove the hooks set up for a previous stream.pipe() call.
This method will remove the hooks set up for a previous stream.pipe() call.
If the destination is not specified, then all pipes are removed.
If the destination is specified, but no pipe is set up for it, then this is a no-op.
- Definition Classes
- Readable
readable.unpipe([destination])
Example: -
def
unshift(chunk: Any): Unit
This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.
This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.
Note that stream.unshift(chunk) cannot be called after the 'end' event has been triggered; a runtime error will be raised.
If you find that you must often call stream.unshift(chunk) in your programs, consider implementing a Transform stream instead.
- Definition Classes
- Readable
readable.unshift(chunk)
Example: - def update(data: Buffer): Unit
- def update(data: String): Unit
- def update(data: String, input_encoding: String): Unit
-
val
usingDomains: Boolean
- Definition Classes
- IEventEmitter
-
def
valueOf(): Any
- Definition Classes
- Object
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
wrap(stream: Any): Unit
Versions of Node.js prior to v0.10 had streams that did not implement the entire Streams API as it is today.
Versions of Node.js prior to v0.10 had streams that did not implement the entire Streams API as it is today. (See Compatibility for more information.)
If you are using an older Node.js library that emits 'data' events and has a stream.pause() method that is advisory only, then you can use the wrap() method to create a Readable stream that uses the old stream as its data source.
You will very rarely ever need to call this function, but it exists as a convenience for interacting with old Node.js programs and libraries.
- Definition Classes
- Readable
readable.wrap(stream)
Example: -
def
write(chunk: |[String, Buffer], encoding: String = null): Boolean
Flush all data, buffered since stream.cork() call.
Flush all data, buffered since stream.cork() call.
- chunk
The data to write (<String> | <Buffer>)
- encoding
The encoding, if chunk is a String
- returns
true, if the data was handled completely
- Definition Classes
- Writable
writable.write(chunk[, encoding][, callback])
Example: -
def
write(chunk: |[String, Buffer], encoding: String, callback: Function): Boolean
Flush all data, buffered since stream.cork() call.
Flush all data, buffered since stream.cork() call.
- chunk
The data to write (<String> | <Buffer>)
- encoding
The encoding, if chunk is a String
- callback
the Callback for when this chunk of data is flushed
- returns
true, if the data was handled completely
- Definition Classes
- Writable
writable.write(chunk[, encoding][, callback])
Example: