diff --git a/.scalafmt.conf b/.scalafmt.conf index af8e3a32a..f2cfa209f 100644 --- a/.scalafmt.conf +++ b/.scalafmt.conf @@ -1,4 +1,4 @@ -version = "2.2.2" +version = "2.3.1" style = defaultWithAlign maxColumn = 120 align.openParenDefnSite = true diff --git a/app/current/src/main/scala/io/scalajs/nodejs/Assert.scala b/app/current/src/main/scala/io/scalajs/nodejs/Assert.scala index 397814e4b..8c5954176 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/Assert.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/Assert.scala @@ -17,6 +17,7 @@ import scala.scalajs.js.| */ @js.native trait Assert extends IEventEmitter { + /** * An alias of assert.ok() . * @param expression the expression to evaluate diff --git a/app/current/src/main/scala/io/scalajs/nodejs/Error.scala b/app/current/src/main/scala/io/scalajs/nodejs/Error.scala index c22df5237..09612d6d2 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/Error.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/Error.scala @@ -14,6 +14,7 @@ import scala.scalajs.js.annotation.{JSGlobal, JSImport} @js.native @JSImport("errors", "Error") class Error(message0: String = js.native) extends js.Object { + /** * The `error.code` property is a string label that identifies the kind of error. * `error.code` is the most stable way to identify an error. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/Module.scala b/app/current/src/main/scala/io/scalajs/nodejs/Module.scala index b65cd2b6a..e681fc3f7 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/Module.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/Module.scala @@ -13,6 +13,7 @@ import scala.scalajs.js.annotation.JSImport */ @js.native trait Module extends js.Object { + /** * The module objects required by this one. * @example module.children diff --git a/app/current/src/main/scala/io/scalajs/nodejs/StringDecoder.scala b/app/current/src/main/scala/io/scalajs/nodejs/StringDecoder.scala index 959d89a8e..7075efbea 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/StringDecoder.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/StringDecoder.scala @@ -14,6 +14,7 @@ import scala.scalajs.js.| @js.native @JSImport("string_decoder", "StringDecoder") class StringDecoder(encoding: String = js.native) extends IEventEmitter { + /** * Returns any trailing bytes that were left in the buffer. * @example decoder.end() diff --git a/app/current/src/main/scala/io/scalajs/nodejs/SystemError.scala b/app/current/src/main/scala/io/scalajs/nodejs/SystemError.scala index 546a1905b..88640473b 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/SystemError.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/SystemError.scala @@ -10,6 +10,7 @@ import scala.scalajs.js.| @js.native @JSImport("errors", "SystemError") class SystemError(message0: String = js.native) extends Error(message0) { + /** * The error.errno property is a number or a string. The number is a negative value which corresponds * to the error code defined in libuv Error handling. See uv-errno.h header file (deps/uv/include/uv-errno.h diff --git a/app/current/src/main/scala/io/scalajs/nodejs/buffer/Buffer.scala b/app/current/src/main/scala/io/scalajs/nodejs/buffer/Buffer.scala index b311d415f..5023bb7bc 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/buffer/Buffer.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/buffer/Buffer.scala @@ -13,6 +13,7 @@ import scala.scalajs.js.| @js.native @JSImport("buffer", "Buffer") class Buffer private[this] () extends Uint8Array( /* dummy to trick constructor */ -1) { + /** * The index operator `[index]` can be used to get and set the octet at position `index` in `buf`. * The values refer to individual bytes, so the legal value range is between `0x00` and `0xFF` (hex) or diff --git a/app/current/src/main/scala/io/scalajs/nodejs/buffer/package.scala b/app/current/src/main/scala/io/scalajs/nodejs/buffer/package.scala index 8c6380f41..a57d3dbbf 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/buffer/package.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/buffer/package.scala @@ -16,6 +16,7 @@ package object buffer { * Buffer Extensions */ implicit final class BufferExtensions(val buffer: Buffer) extends AnyVal { + /** * Syntactic sugar for concatenating a buffer * @@ -102,6 +103,7 @@ package object buffer { @js.native @JSImport("buffer", "constants") object constants extends js.Object { + /** * The largest size allowed for a single `Buffer` instance. * diff --git a/app/current/src/main/scala/io/scalajs/nodejs/cluster/ClusterSettings.scala b/app/current/src/main/scala/io/scalajs/nodejs/cluster/ClusterSettings.scala index a84ded0ca..bb224f8f6 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/cluster/ClusterSettings.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/cluster/ClusterSettings.scala @@ -11,6 +11,7 @@ import scala.scalajs.js.| */ @js.native trait ClusterSettings extends js.Object { + /** list of string arguments passed to the Node.js executable. (Default=process.execArgv) */ var execArgv: js.Array[String] = js.native diff --git a/app/current/src/main/scala/io/scalajs/nodejs/cluster/package.scala b/app/current/src/main/scala/io/scalajs/nodejs/cluster/package.scala index 765df2705..002c3fa75 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/cluster/package.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/cluster/package.scala @@ -21,6 +21,7 @@ package object cluster { * @param cluster the given [[Cluster cluster]] */ implicit final class ClusterEvents(private val cluster: Cluster) extends AnyVal { + /** * Emitted after the worker IPC channel has disconnected. This can occur when a worker exits gracefully, is killed, * or is disconnected manually (such as with worker.disconnect()). diff --git a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Cipher.scala b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Cipher.scala index bcfff237b..5656e68b9 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Cipher.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Cipher.scala @@ -17,6 +17,7 @@ import scala.scalajs.js */ @js.native sealed trait Cipher extends Transform { + /** * Returns any remaining enciphered contents. If output_encoding parameter is one of 'binary', 'base64' or 'hex', * a string is returned. If an output_encoding is not provided, a Buffer is returned. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Decipher.scala b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Decipher.scala index e66ffaa8a..1b70af1c2 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Decipher.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Decipher.scala @@ -17,6 +17,7 @@ import scala.scalajs.js */ @js.native sealed trait Decipher extends Transform { + /** * Returns any remaining deciphered contents. If output_encoding parameter is one of 'binary', 'base64' or 'hex', * a string is returned. If an output_encoding is not provided, a Buffer is returned. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Hash.scala b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Hash.scala index ce23d34d0..dd51fac32 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Hash.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Hash.scala @@ -16,6 +16,7 @@ import scala.scalajs.js */ @js.native sealed trait Hash extends Transform { + /** * Calculates the digest of all of the data passed to be hashed (using the hash.update() method). The encoding can * be 'hex', 'binary' or 'base64'. If encoding is provided a string will be returned; otherwise a Buffer is returned. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Hmac.scala b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Hmac.scala index 28e18611b..6924610c1 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Hmac.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Hmac.scala @@ -17,6 +17,7 @@ import scala.scalajs.js */ @js.native sealed trait Hmac extends Transform { + /** * Calculates the HMAC digest of all of the data passed using hmac.update(). The encoding can be 'hex', 'binary' * or 'base64'. If encoding is provided a string is returned; otherwise a Buffer is returned; diff --git a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Verify.scala b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Verify.scala index 6fefed1fa..5775fc657 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/crypto/Verify.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/crypto/Verify.scala @@ -18,6 +18,7 @@ import scala.scalajs.js.| */ @js.native trait Verify extends Writable { + /** * Updates the Verify content with the given data. * This can be called many times with new data as it is streamed. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/dgram/Socket.scala b/app/current/src/main/scala/io/scalajs/nodejs/dgram/Socket.scala index a858e3e2c..bd225c452 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/dgram/Socket.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/dgram/Socket.scala @@ -17,6 +17,7 @@ import scala.scalajs.js.annotation.JSImport @js.native @JSImport("dgram", "Socket") class Socket private[this] () extends IEventEmitter { + /** * Tells the kernel to join a multicast group at the given multicastAddress and multicastInterface using the * IP_ADD_MEMBERSHIP socket option. If the multicastInterface argument is not specified, the operating system diff --git a/app/current/src/main/scala/io/scalajs/nodejs/dns/DNS.scala b/app/current/src/main/scala/io/scalajs/nodejs/dns/DNS.scala index 54627a220..0cefd4987 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/dns/DNS.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/dns/DNS.scala @@ -14,6 +14,7 @@ import scala.scalajs.js.| */ @js.native trait DNS extends IResolver { + /** * Resolves a hostname (e.g. 'nodejs.org') into the first found A (IPv4) or AAAA (IPv6) record. options can be an * object or integer. If options is not provided, then IPv4 and IPv6 addresses are both valid. If options is an diff --git a/app/current/src/main/scala/io/scalajs/nodejs/dns/package.scala b/app/current/src/main/scala/io/scalajs/nodejs/dns/package.scala index 77a6c80ff..3de8ff27f 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/dns/package.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/dns/package.scala @@ -63,6 +63,7 @@ package object dns { * @param dns the DNS instance */ implicit final class DNSExtensions(private val dns: DNS) extends AnyVal { + /** * Resolves a hostname (e.g. 'nodejs.org') into the first found A (IPv4) or AAAA (IPv6) record. options can be an * object or integer. If options is not provided, then IPv4 and IPv6 addresses are both valid. If options is an diff --git a/app/current/src/main/scala/io/scalajs/nodejs/events/EventEmitter.scala b/app/current/src/main/scala/io/scalajs/nodejs/events/EventEmitter.scala index 5ec4549b7..c6fd768c0 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/events/EventEmitter.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/events/EventEmitter.scala @@ -141,6 +141,7 @@ trait IEventEmitter extends js.Object { @js.native @JSImport("events", JSImport.Namespace) object EventEmitter extends IEventEmitter { + /** * By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed * for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default diff --git a/app/current/src/main/scala/io/scalajs/nodejs/fs/FSWatcher.scala b/app/current/src/main/scala/io/scalajs/nodejs/fs/FSWatcher.scala index 50ff1e46f..10c0797dd 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/fs/FSWatcher.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/fs/FSWatcher.scala @@ -10,6 +10,7 @@ import scala.scalajs.js */ @js.native trait FSWatcher extends IEventEmitter { + /** * Stop watching for changes on the given fs.FSWatcher. * @example watcher.close() @@ -22,10 +23,12 @@ trait FSWatcher extends IEventEmitter { * File System Watcher Companion */ object FSWatcher { + /** * File System Watcher Extensions */ implicit final class FSWatcherExtensions(val watcher: FSWatcher) extends AnyVal { + /** * Emitted when something changes in a watched directory or file. See more details in fs.watch(). * diff --git a/app/current/src/main/scala/io/scalajs/nodejs/fs/Fs.scala b/app/current/src/main/scala/io/scalajs/nodejs/fs/Fs.scala index 85a3b5cd5..1b291328d 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/fs/Fs.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/fs/Fs.scala @@ -23,6 +23,7 @@ import scala.scalajs.js.| */ @js.native trait Fs extends IEventEmitter with FSConstants { + /** * Returns an object containing commonly used constants for file system operations * @return an [[FSConstants object]] containing commonly used constants for file system operations diff --git a/app/current/src/main/scala/io/scalajs/nodejs/fs/ReadStream.scala b/app/current/src/main/scala/io/scalajs/nodejs/fs/ReadStream.scala index 3b15ec544..6a2a9e090 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/fs/ReadStream.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/fs/ReadStream.scala @@ -52,10 +52,12 @@ class ReadStream(path: Path) extends stream.Readable { * Read Stream Companion */ object ReadStream { + /** * Read Stream Events */ implicit final class ReadStreamEvents(val stream: ReadStream) extends AnyVal { + /** * Emitted when the ReadStream's underlying file descriptor has been closed using the fs.close() method. * @param listener the event handler diff --git a/app/current/src/main/scala/io/scalajs/nodejs/fs/WriteStream.scala b/app/current/src/main/scala/io/scalajs/nodejs/fs/WriteStream.scala index dea195040..bfca6c673 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/fs/WriteStream.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/fs/WriteStream.scala @@ -48,10 +48,12 @@ class WriteStream(path: Path) extends stream.Writable { * Write Stream Companion */ object WriteStream { + /** * Write Stream Events */ implicit final class WriteStreamEvents(val stream: WriteStream) extends AnyVal { + /** * Emitted when the WriteStream's underlying file descriptor has been closed using the fs.close() method. * @param listener the event handler diff --git a/app/current/src/main/scala/io/scalajs/nodejs/http/Agent.scala b/app/current/src/main/scala/io/scalajs/nodejs/http/Agent.scala index 6d79dc2bc..c30561ad9 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/http/Agent.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/http/Agent.scala @@ -97,10 +97,12 @@ class Agent(options: AgentOptions = js.native) extends js.Object { * Agent Companion */ object Agent { + /** * Agent Extensions */ implicit final class AgentExtensions(val agent: Agent) extends AnyVal { + /** * Produces a socket/stream to be used for HTTP requests. By default, this function is the same * as net.createConnection(). However, custom Agents may override this method in case greater diff --git a/app/current/src/main/scala/io/scalajs/nodejs/http/ClientRequest.scala b/app/current/src/main/scala/io/scalajs/nodejs/http/ClientRequest.scala index efafd35ad..72b51521b 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/http/ClientRequest.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/http/ClientRequest.scala @@ -115,6 +115,7 @@ class ClientRequest extends stream.Writable { */ object ClientRequest { implicit final class ClientRequestExtensions(val client: ClientRequest) extends AnyVal { + /** * Emitted when the request has been aborted by the client. This event is only emitted on the first call to abort(). */ diff --git a/app/current/src/main/scala/io/scalajs/nodejs/http/IncomingMessage.scala b/app/current/src/main/scala/io/scalajs/nodejs/http/IncomingMessage.scala index 857ed4431..f818268c0 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/http/IncomingMessage.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/http/IncomingMessage.scala @@ -97,6 +97,7 @@ class IncomingMessage extends stream.Readable { * Incoming Message Companion */ object IncomingMessage { + /** * Incoming Message Extensions */ diff --git a/app/current/src/main/scala/io/scalajs/nodejs/http/Server.scala b/app/current/src/main/scala/io/scalajs/nodejs/http/Server.scala index 855491ba9..212650a70 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/http/Server.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/http/Server.scala @@ -27,11 +27,13 @@ class Server extends net.Server { * Server Companion */ object Server { + /** * Server Events * @param server the given [[Server]] */ implicit final class ServerEvents(val server: Server) extends AnyVal { + /** * Emitted each time a request with an HTTP Expect: 100-continue is received. If this event is not listened for, * the server will automatically respond with a 100 Continue as appropriate. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/http/ServerResponse.scala b/app/current/src/main/scala/io/scalajs/nodejs/http/ServerResponse.scala index 553f39fc8..f67532b05 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/http/ServerResponse.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/http/ServerResponse.scala @@ -147,6 +147,7 @@ trait ServerResponse extends stream.Writable { * Server Response */ object ServerResponse { + /** * Server Response Events */ diff --git a/app/current/src/main/scala/io/scalajs/nodejs/http/package.scala b/app/current/src/main/scala/io/scalajs/nodejs/http/package.scala index ee39bd4ae..df56c5b4e 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/http/package.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/http/package.scala @@ -10,10 +10,12 @@ import scala.scalajs.js * http package object */ package object http { + /** * Http Extensions */ implicit final class HttpExtensions(val http: Http) extends AnyVal { + /** * @see [[Http.createServer()]] */ @@ -62,6 +64,7 @@ package object http { * Server Events */ implicit final class ServerEvents(val server: Server) extends AnyVal { + /** * Emitted each time a request with an http Expect: 100-continue is received. If this event isn't listened for, * the server will automatically respond with a 100 Continue as appropriate. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/https/package.scala b/app/current/src/main/scala/io/scalajs/nodejs/https/package.scala index e32aaec90..6aed1e94f 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/https/package.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/https/package.scala @@ -12,10 +12,12 @@ import scala.scalajs.js.| * https package object */ package object https { + /** * Https Extensions */ implicit final class HttpExtensions(val https: Https) extends AnyVal { + /** * Like http.get() but for HTTPS. */ diff --git a/app/current/src/main/scala/io/scalajs/nodejs/net/Server.scala b/app/current/src/main/scala/io/scalajs/nodejs/net/Server.scala index 1ee28d58f..5e6cad98d 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/net/Server.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/net/Server.scala @@ -98,11 +98,13 @@ class Server(options: ServerOptions = js.native) extends IEventEmitter { * Server Companion */ object Server extends { + /** * Server Events * @param server the given [[Server]] */ implicit final class ServerEvents(val server: Server) extends AnyVal { + /** * Emitted when the server closes. Note that if connections exist, this event is not emitted until all * connections are ended. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/net/Socket.scala b/app/current/src/main/scala/io/scalajs/nodejs/net/Socket.scala index 4704e3bf5..fd77a5328 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/net/Socket.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/net/Socket.scala @@ -14,6 +14,7 @@ import scala.scalajs.js.annotation.JSImport @js.native @JSImport("net", "Socket") class Socket(options: SocketOptions = js.native) extends stream.Duplex with HasHandle { + /** * net.Socket has the property that socket.write() always works. This is to help users get up and running quickly. * The computer cannot always keep up with the amount of data that is written to a socket - the network connection diff --git a/app/current/src/main/scala/io/scalajs/nodejs/net/package.scala b/app/current/src/main/scala/io/scalajs/nodejs/net/package.scala index d2904c266..b861a3c4a 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/net/package.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/net/package.scala @@ -17,6 +17,7 @@ package object net { * @param server the given [[Server server]] */ implicit final class ServerEvents(val server: Server) extends AnyVal { + /** * Emitted when a new connection is made. socket is an instance of net.Socket. * @example server.on("close", function () { ... }) diff --git a/app/current/src/main/scala/io/scalajs/nodejs/process/Process.scala b/app/current/src/main/scala/io/scalajs/nodejs/process/Process.scala index 565a89e10..ecc4a52c2 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/process/Process.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/process/Process.scala @@ -457,6 +457,7 @@ trait ComponentVersion extends js.Object { */ @js.native trait Warning extends js.Object { + /** * The name of the warning (currently Warning by default). */ diff --git a/app/current/src/main/scala/io/scalajs/nodejs/punycode/Punycode.scala b/app/current/src/main/scala/io/scalajs/nodejs/punycode/Punycode.scala index 11dfd69d9..d8548eb87 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/punycode/Punycode.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/punycode/Punycode.scala @@ -11,6 +11,7 @@ import scala.scalajs.js.annotation.JSImport */ @js.native trait Punycode extends js.Object { + /** * The punycode.decode() method converts a Punycode string of ASCII-only characters to the equivalent * string of Unicode codepoints. @@ -62,6 +63,7 @@ trait Punycode extends js.Object { */ @js.native trait UCS2 extends js.Object { + /** * The punycode.ucs2.decode() method returns an array containing the numeric codepoint values of each Unicode * symbol in the string. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/querystring/QueryString.scala b/app/current/src/main/scala/io/scalajs/nodejs/querystring/QueryString.scala index 7121cb1e1..fcccc591a 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/querystring/QueryString.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/querystring/QueryString.scala @@ -16,6 +16,7 @@ object QueryString extends QueryString */ @js.native trait QueryString extends js.Object { + /** * The querystring.escape() method performs URL percent-encoding on the given str in a manner that is optimized * for the specific requirements of URL query strings. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/querystring/package.scala b/app/current/src/main/scala/io/scalajs/nodejs/querystring/package.scala index 253ccd747..8ed65e20f 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/querystring/package.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/querystring/package.scala @@ -6,6 +6,7 @@ import scala.scalajs.js * query string package object */ package object querystring { + /** * Query String Enrichment * @param qs the given [[QueryString]] diff --git a/app/current/src/main/scala/io/scalajs/nodejs/readline/Interface.scala b/app/current/src/main/scala/io/scalajs/nodejs/readline/Interface.scala index dd942ab36..655d6944e 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/readline/Interface.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/readline/Interface.scala @@ -10,6 +10,7 @@ import scala.scalajs.js */ @js.native trait Interface extends IEventEmitter { + /** * Closes the Interface instance, relinquishing control on the input and output streams. * The 'close' event will also be emitted. @@ -94,11 +95,13 @@ class Key( * Readline Interface Companion */ object Interface { + /** * Readline Interface Events * @param readline the given [[Interface Readline Interface]] */ implicit final class ReadlineEvents(val readline: Interface) extends AnyVal { + /** * Emitted when close() is called. Also emitted when the input stream receives its 'end' event. * The Interface instance should be considered "finished" once this is emitted. For example, when diff --git a/app/current/src/main/scala/io/scalajs/nodejs/readline/Readline.scala b/app/current/src/main/scala/io/scalajs/nodejs/readline/Readline.scala index 8804ad613..fd3d72aaf 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/readline/Readline.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/readline/Readline.scala @@ -14,6 +14,7 @@ import scala.scalajs.js.annotation.JSImport */ @js.native trait Readline extends IEventEmitter { + /** * Clears current line of given TTY stream in a specified direction. dir should have one of following values: * */ implicit final class EnvironmentVariableOptions(private val env: process.Environment) extends AnyVal { + /** * When a valid path is given, persistent REPL history will be saved to the specified file rather * than .node_repl_history in the user's home directory. Setting this value to "" will disable persistent diff --git a/app/current/src/main/scala/io/scalajs/nodejs/stream/Stream.scala b/app/current/src/main/scala/io/scalajs/nodejs/stream/Stream.scala index 8d2f80171..65542cb94 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/stream/Stream.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/stream/Stream.scala @@ -240,10 +240,12 @@ sealed trait IReadable extends LegacyStream { * Readable Companion */ object IReadable { + /** * Readable Events */ implicit final class ReadableExtesions(val readable: IReadable) extends AnyVal { + /** * Emitted when the stream and any of its underlying resources (a file descriptor, for example) have been closed. * The event indicates that no more events will be emitted, and no further computation will occur. @@ -415,10 +417,12 @@ sealed trait IWritable extends LegacyStream { * Writable Companion */ object IWritable { + /** * Writable Events */ implicit final class WritableExtension(val writable: IWritable) extends AnyVal { + /** * Emitted when the stream and any of its underlying resources (a file descriptor, for example) have been closed. * The event indicates that no more events will be emitted, and no further computation will occur. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearImmediate.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearImmediate.scala index 518e61cf1..11ef23bc9 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearImmediate.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearImmediate.scala @@ -8,6 +8,7 @@ import scala.scalajs.js */ @js.native trait ClearImmediate extends js.Object { + /** * Stops an immediate, as created by setImmediate, from triggering. * @param handle the immediate handle diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearInterval.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearInterval.scala index 7631d4c6a..eae59801e 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearInterval.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearInterval.scala @@ -8,6 +8,7 @@ import scala.scalajs.js */ @js.native trait ClearInterval extends js.Object { + /** * Stops an interval, as created by setInterval, from triggering. * @example clearInterval(intervalObject) diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearTimeout.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearTimeout.scala index d6aaf442f..50bab378d 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearTimeout.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/ClearTimeout.scala @@ -8,6 +8,7 @@ import scala.scalajs.js */ @js.native trait ClearTimeout extends js.Object { + /** * Prevents a timeout, as created by setTimeout, from triggering. * @example clearTimeout(timeoutObject) diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/Immediate.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/Immediate.scala index b94dd8a5d..77847e299 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/Immediate.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/Immediate.scala @@ -26,6 +26,7 @@ trait Immediate extends js.Object { * Immediate Companion */ object Immediate { + /** * Immediate Enrichment * @param immediate the given [[Immediate immediate]] handle diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/Interval.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/Interval.scala index 057adad6a..2e6a7cdfc 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/Interval.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/Interval.scala @@ -9,6 +9,7 @@ import scala.scalajs.js */ @js.native trait Interval extends js.Object { + /** * Indicates whether the interval has been called * @return true, if the interval has already been called @@ -20,6 +21,7 @@ trait Interval extends js.Object { * Interval Companion */ object Interval { + /** * Interval Enrichment * @param handle the given [[Interval interval]] handle diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/Ref.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/Ref.scala index 6be9e5f05..3bf02e5e0 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/Ref.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/Ref.scala @@ -8,6 +8,7 @@ import scala.scalajs.js */ @js.native trait Ref extends js.Object { + /** * If a timer was previously unref()d, then ref() can be called to explicitly request the timer hold the * program open. If the timer is already refd calling ref again will have no effect. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/SetImmediate.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/SetImmediate.scala index 8f868421a..014184627 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/SetImmediate.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/SetImmediate.scala @@ -9,6 +9,7 @@ import scala.scalajs.js */ @js.native trait SetImmediate extends js.Object { + /** * Schedules "immediate" execution of callback after I/O events' callbacks and before timers set * by setTimeout and setInterval are triggered. Returns an immediateObject for possible use with diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/SetInterval.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/SetInterval.scala index e9d588491..f3913609e 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/SetInterval.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/SetInterval.scala @@ -8,6 +8,7 @@ import scala.scalajs.js */ @js.native trait SetInterval extends js.Object { + /** * Schedules repeated execution of callback every delay milliseconds. Returns a intervalObject for possible * use with clearInterval. Additional optional arguments may be passed to the callback. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/SetTimeout.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/SetTimeout.scala index 34e162686..dab49e670 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/SetTimeout.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/SetTimeout.scala @@ -8,6 +8,7 @@ import scala.scalajs.js */ @js.native trait SetTimeout extends js.Object { + /** * Schedules execution of a one-time callback after delay milliseconds. Returns a timeoutObject for possible * use with clearTimeout. Additional optional arguments may be passed to the callback. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/Timeout.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/Timeout.scala index 8a8e74a46..52594cc31 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/Timeout.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/Timeout.scala @@ -10,6 +10,7 @@ import scala.scalajs.js */ @js.native trait Timeout extends js.Object { + /** * Indicates whether the timeout has been called * @return true, if the timeout has already been called @@ -29,6 +30,7 @@ trait Timeout extends js.Object { * Timeout Companion */ object Timeout { + /** * Timeout Enrichment * @param handle the given [[Timeout timeout]] handle diff --git a/app/current/src/main/scala/io/scalajs/nodejs/timers/UnRef.scala b/app/current/src/main/scala/io/scalajs/nodejs/timers/UnRef.scala index befbbaf0b..48249776b 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/timers/UnRef.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/timers/UnRef.scala @@ -9,6 +9,7 @@ import scala.scalajs.js */ @js.native trait UnRef extends js.Object { + /** * The opaque value returned by setTimeout and setInterval also has the method timer.unref() which allows * the creation of a timer that is active but if it is the only item left in the event loop, it won't keep diff --git a/app/current/src/main/scala/io/scalajs/nodejs/tls/Server.scala b/app/current/src/main/scala/io/scalajs/nodejs/tls/Server.scala index f8ef8b6b6..dd00b31e9 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/tls/Server.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/tls/Server.scala @@ -14,6 +14,7 @@ import scala.scalajs.js.annotation.JSImport @js.native @JSImport("tls", "Server") class Server extends net.Server { + /** * The server.addContext() method adds a secure context that will be used if the client request's SNI hostname * matches the supplied hostname (or wildcard). diff --git a/app/current/src/main/scala/io/scalajs/nodejs/tty/WriteStream.scala b/app/current/src/main/scala/io/scalajs/nodejs/tty/WriteStream.scala index 9cccede55..abc301255 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/tty/WriteStream.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/tty/WriteStream.scala @@ -17,6 +17,7 @@ import scala.scalajs.js.annotation.JSImport @js.native @JSImport("tty", "WriteStream") class WriteStream(fd: FileDescriptor) extends net.Socket { + /** * A number specifying the number of columns the TTY currently has. This property is updated whenever * the 'resize' event is emitted. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/tty/package.scala b/app/current/src/main/scala/io/scalajs/nodejs/tty/package.scala index f583627c8..60471b45a 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/tty/package.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/tty/package.scala @@ -4,11 +4,13 @@ package io.scalajs.nodejs * tty package object */ package object tty { + /** * Write Stream Events * @param stream the given [[WriteStream stream]] */ implicit final class WriteStreamEvents(val stream: WriteStream) extends AnyVal { + /** * The 'resize' event is emitted whenever either of the writeStream.columns or writeStream.rows properties have * changed. No arguments are passed to the listener callback when called. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/url/URL.scala b/app/current/src/main/scala/io/scalajs/nodejs/url/URL.scala index 16d4953a8..2d3ffdf10 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/url/URL.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/url/URL.scala @@ -17,6 +17,7 @@ import scala.scalajs.js.| @js.native @JSImport("url", "URL") class URL(input: String, base: String | URL = js.native) extends js.Object { + /** * The auth property is the username and password portion of the URL, also referred to as "userinfo". * This string subset follows the protocol and double slashes (if present) and precedes the host component, @@ -108,6 +109,7 @@ class URL(input: String, base: String | URL = js.native) extends js.Object { @js.native @JSImport("url", JSImport.Namespace) object URL extends IEventEmitter { + /** * Take a parsed URL object, and return a formatted URL string. * @example url.format(urlObj) diff --git a/app/current/src/main/scala/io/scalajs/nodejs/url/URLObject.scala b/app/current/src/main/scala/io/scalajs/nodejs/url/URLObject.scala index 53a4631bf..a21126c5e 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/url/URLObject.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/url/URLObject.scala @@ -8,6 +8,7 @@ import scala.scalajs.js @js.native @deprecated("Use URL instead", "Node.js v11.0.0") trait URLObject extends js.Object { + /** * The auth property is the username and password portion of the URL, also referred to as "userinfo". * This string subset follows the protocol and double slashes (if present) and precedes the host component, diff --git a/app/current/src/main/scala/io/scalajs/nodejs/url/URLSearchParams.scala b/app/current/src/main/scala/io/scalajs/nodejs/url/URLSearchParams.scala index 9222688ce..0d5f5e311 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/url/URLSearchParams.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/url/URLSearchParams.scala @@ -14,6 +14,7 @@ import scala.scalajs.js.annotation.JSImport @js.native @JSImport("url", "URLSearchParams") class URLSearchParams() extends js.Object { + /** * Parse the string as a query string, and use it to instantiate a new URLSearchParams object. * A leading '?', if present, is ignored. diff --git a/app/current/src/main/scala/io/scalajs/nodejs/util/Util.scala b/app/current/src/main/scala/io/scalajs/nodejs/util/Util.scala index 7004e6389..e4db081b8 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/util/Util.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/util/Util.scala @@ -16,6 +16,7 @@ import scala.scalajs.js.annotation.JSImport */ @js.native trait Util extends js.Object { + /** * This is used to create a function which conditionally writes to stderr based on the existence of a NODE_DEBUG * environment variable. If the section name appears in that environment variable, then the returned function will diff --git a/app/current/src/main/scala/io/scalajs/nodejs/zlib/package.scala b/app/current/src/main/scala/io/scalajs/nodejs/zlib/package.scala index ab7b0d99d..b9da12d42 100644 --- a/app/current/src/main/scala/io/scalajs/nodejs/zlib/package.scala +++ b/app/current/src/main/scala/io/scalajs/nodejs/zlib/package.scala @@ -24,6 +24,7 @@ package object zlib { * Zlib Extensions */ implicit final class ZlibExtensions(val zlib: Zlib) extends AnyVal { + /** * Asynchronously compresses a Buffer or string with Deflate. */ diff --git a/app/nodejs-v8/src/test/scala/io/scalajs/nodejs/fs/FsTest.scala b/app/nodejs-v8/src/test/scala/io/scalajs/nodejs/fs/FsTest.scala index bab97dbc3..21c935a3c 100644 --- a/app/nodejs-v8/src/test/scala/io/scalajs/nodejs/fs/FsTest.scala +++ b/app/nodejs-v8/src/test/scala/io/scalajs/nodejs/fs/FsTest.scala @@ -26,13 +26,12 @@ class FsTest extends AsyncFunSpec { }) assert(watcher !== null) - setImmediate( - () => - Fs.writeFile(s"${testResources}1.txt", "Hello", error => { - if (isDefined(error)) { - promise.failure(error.toException) - } - }) + setImmediate(() => + Fs.writeFile(s"${testResources}1.txt", "Hello", error => { + if (isDefined(error)) { + promise.failure(error.toException) + } + }) ) promise.future.map { diff --git a/app/nodejs-v8/src/test/scala/io/scalajs/nodejs/vm/VMTest.scala b/app/nodejs-v8/src/test/scala/io/scalajs/nodejs/vm/VMTest.scala index 18694c535..e864d7177 100644 --- a/app/nodejs-v8/src/test/scala/io/scalajs/nodejs/vm/VMTest.scala +++ b/app/nodejs-v8/src/test/scala/io/scalajs/nodejs/vm/VMTest.scala @@ -46,6 +46,7 @@ class VMTest extends FunSpec { * VM Test Companion */ object VMTest { + /** * Sandbox Object */ diff --git a/core/src/main/scala/io/scalajs/util/DateHelper.scala b/core/src/main/scala/io/scalajs/util/DateHelper.scala index d90b51dc5..2f2df85e6 100644 --- a/core/src/main/scala/io/scalajs/util/DateHelper.scala +++ b/core/src/main/scala/io/scalajs/util/DateHelper.scala @@ -7,6 +7,7 @@ import scala.scalajs.js * Date Helper */ object DateHelper { + /** * Date Enrichment * @param date0 the given [[js.Date date]] diff --git a/core/src/main/scala/io/scalajs/util/JSONHelper.scala b/core/src/main/scala/io/scalajs/util/JSONHelper.scala index abd045363..076bc510a 100644 --- a/core/src/main/scala/io/scalajs/util/JSONHelper.scala +++ b/core/src/main/scala/io/scalajs/util/JSONHelper.scala @@ -6,6 +6,7 @@ import scala.scalajs.js * JSON Helper */ object JSONHelper { + /** * JSON Conversions * @param value the given JavaScript value diff --git a/core/src/main/scala/io/scalajs/util/PromiseHelper.scala b/core/src/main/scala/io/scalajs/util/PromiseHelper.scala index 3b9e30bd8..9ab139212 100644 --- a/core/src/main/scala/io/scalajs/util/PromiseHelper.scala +++ b/core/src/main/scala/io/scalajs/util/PromiseHelper.scala @@ -8,6 +8,7 @@ import scala.scalajs.runtime.wrapJavaScriptException * Promise Helper */ object PromiseHelper { + /** * Converts a JavaScript-style callback to a Scala.js promise * @param f the given callback function @@ -130,9 +131,7 @@ object PromiseHelper { @inline def promiseWithErrorAsBoolean[Z](f: js.Function1[Z, Any] => Unit): Future[Boolean] = { val task = Promise[Boolean]() - f( - (err: Z) => if (err == null || js.isUndefined(err)) task.success(true) else task.success(false) - ) + f((err: Z) => if (err == null || js.isUndefined(err)) task.success(true) else task.success(false)) task.future } @@ -144,9 +143,8 @@ object PromiseHelper { @inline def promiseWithError0[Z](f: js.Function1[Z, Any] => Unit): Future[Unit] = { val task = Promise[Unit]() - f( - (err: Z) => - if (err == null || js.isUndefined(err)) task.success({}) else task.failure(wrapJavaScriptException(err)) + f((err: Z) => + if (err == null || js.isUndefined(err)) task.success({}) else task.failure(wrapJavaScriptException(err)) ) task.future } @@ -159,9 +157,8 @@ object PromiseHelper { @inline def promiseWithError1[Z, A](f: js.Function2[Z, A, Any] => Unit): Future[A] = { val task = Promise[A]() - f( - (err: Z, a: A) => - if (err == null || js.isUndefined(err)) task.success(a) else task.failure(wrapJavaScriptException(err)) + f((err: Z, a: A) => + if (err == null || js.isUndefined(err)) task.success(a) else task.failure(wrapJavaScriptException(err)) ) task.future } @@ -174,9 +171,8 @@ object PromiseHelper { @inline def promiseWithError2[Z, A, B](f: js.Function3[Z, A, B, Any] => Unit): Future[(A, B)] = { val task = Promise[(A, B)]() - f( - (err: Z, a: A, b: B) => - if (err == null || js.isUndefined(err)) task.success((a, b)) else task.failure(wrapJavaScriptException(err)) + f((err: Z, a: A, b: B) => + if (err == null || js.isUndefined(err)) task.success((a, b)) else task.failure(wrapJavaScriptException(err)) ) task.future } @@ -189,9 +185,8 @@ object PromiseHelper { @inline def promiseWithError3[Z, A, B, C](f: js.Function4[Z, A, B, C, Any] => Unit): Future[(A, B, C)] = { val task = Promise[(A, B, C)]() - f( - (err: Z, a: A, b: B, c: C) => - if (err == null || js.isUndefined(err)) task.success((a, b, c)) else task.failure(wrapJavaScriptException(err)) + f((err: Z, a: A, b: B, c: C) => + if (err == null || js.isUndefined(err)) task.success((a, b, c)) else task.failure(wrapJavaScriptException(err)) ) task.future } @@ -204,10 +199,9 @@ object PromiseHelper { @inline def promiseWithError4[Z, A, B, C, D](f: js.Function5[Z, A, B, C, D, Any] => Unit): Future[(A, B, C, D)] = { val task = Promise[(A, B, C, D)]() - f( - (err: Z, a: A, b: B, c: C, d: D) => - if (err == null || js.isUndefined(err)) task.success((a, b, c, d)) - else task.failure(wrapJavaScriptException(err)) + f((err: Z, a: A, b: B, c: C, d: D) => + if (err == null || js.isUndefined(err)) task.success((a, b, c, d)) + else task.failure(wrapJavaScriptException(err)) ) task.future } @@ -220,10 +214,9 @@ object PromiseHelper { @inline def promiseWithError5[Z, A, B, C, D, E](f: js.Function6[Z, A, B, C, D, E, Any] => Unit): Future[(A, B, C, D, E)] = { val task = Promise[(A, B, C, D, E)]() - f( - (err: Z, a: A, b: B, c: C, d: D, e: E) => - if (err == null || js.isUndefined(err)) task.success((a, b, c, d, e)) - else task.failure(wrapJavaScriptException(err)) + f((err: Z, a: A, b: B, c: C, d: D, e: E) => + if (err == null || js.isUndefined(err)) task.success((a, b, c, d, e)) + else task.failure(wrapJavaScriptException(err)) ) task.future } @@ -238,10 +231,9 @@ object PromiseHelper { f: js.Function7[Z, A, B, C, D, E, F, Any] => Unit ): Future[(A, B, C, D, E, F)] = { val task = Promise[(A, B, C, D, E, F)]() - f( - (err: Z, a: A, b: B, c: C, d: D, e: E, f: F) => - if (err == null || js.isUndefined(err)) task.success((a, b, c, d, e, f)) - else task.failure(wrapJavaScriptException(err)) + f((err: Z, a: A, b: B, c: C, d: D, e: E, f: F) => + if (err == null || js.isUndefined(err)) task.success((a, b, c, d, e, f)) + else task.failure(wrapJavaScriptException(err)) ) task.future }