package nodejs
nodejs package object
- Alphabetic
- By Inheritance
- nodejs
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
trait
Assert
extends Object with IEventEmitter
The assert module provides a simple set of assertion tests that can be used to test invariants.
The assert module provides a simple set of assertion tests that can be used to test invariants. The module is intended for internal use by Node.js, but can be used in application code via require('assert'). However, assert is not a testing framework, and is not intended to be used as a general purpose assertion library.
The API for the assert module is Locked. This means that there will be no additions or changes to any of the methods implemented and exposed by the module.
- Annotations
- @RawJSType() @native()
-
class
Console
extends Object
The console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.
The console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.
The module exports two specific components:
- A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
- A global console instance configured to write to stdout and stderr. Because this object is global, it can be used without calling require('console').
- Annotations
- @RawJSType() @native() @JSImport( "console" , "Console" )
- See also
https://nodejs.org/dist/latest-v8.x/docs/api/console.html
-
class
ConsoleDirOptions
extends Object
Console Dir Options
Console Dir Options
- Annotations
- @ScalaJSDefined() @RawJSType()
- type Environment = Dictionary[String]
-
class
Error
extends Object
Creates a new Error object and sets the error.message property to the provided text message.
Creates a new Error object and sets the error.message property to the provided text message. If an object is passed as message, the text message is generated by calling message.toString(). The error.stack property will represent the point in the code at which new Error() was called. Stack traces are dependent on V8's stack trace API. Stack traces extend only to either (a) the beginning of synchronous code execution, or (b) the number of frames given by the property Error.stackTraceLimit, whichever is smaller.
- Annotations
- @RawJSType() @native() @JSImport( "errors" , "Error" )
- type EventType = String
- type ExitCode = Int
-
type
FileDescriptor = Integer
Represents a file descriptor
- type FileIOError = SystemError
- type FileMode = Integer
- type FileType = Int
- type Flags = |[String, Int]
- type FsCallback0 = Function1[FileIOError, Any]
- type FsCallback1[A] = Function2[FileIOError, A, Any]
- type FsCallback2[A, B] = Function3[FileIOError, A, B, Any]
- type FsCallback3[A, B, C] = Function4[FileIOError, A, B, C, Any]
- type GID = Int
-
trait
Global
extends Object
In browsers, the top-level scope is the global scope.
In browsers, the top-level scope is the global scope. That means that in browsers if you're in the global scope var something will define a global variable. In Node.js this is different. The top-level scope is not the global scope; var something inside an Node.js module will be local to that module.
- Annotations
- @RawJSType() @native()
-
trait
Module
extends Object
In each module, the module free variable is a reference to the object representing the current module.
In each module, the module free variable is a reference to the object representing the current module. For convenience, module.exports is also accessible via the exports module-global. module isn't actually a global but rather local to each module.
- Annotations
- @RawJSType() @native()
- See also
https://nodejs.org/api/modules.html#modules_the_module_object
-
trait
Process
extends Object with IEventEmitter
The process object is a global object and can be accessed from anywhere.
The process object is a global object and can be accessed from anywhere. It is an instance of EventEmitter.
- Annotations
- @RawJSType() @native()
-
class
SystemError
extends Error
System Error
System Error
- Annotations
- @RawJSType() @native() @JSImport( "errors" , "SystemError" )
- type UID = Int
Value Members
-
val
FatalError: ExitCode
There was a fatal unrecoverable error in V8.
There was a fatal unrecoverable error in V8. Typically a message will be printed to stderr with the prefix FATAL ERROR.
-
val
InternalExceptionHandlerRunTimeFailure: ExitCode
There was an uncaught exception, and the internal fatal exception handler function itself threw an error while attempting to handle it.
There was an uncaught exception, and the internal fatal exception handler function itself threw an error while attempting to handle it. This can happen, for example, if a 'uncaughtException' or domain.on('error') handler throws an error.
-
val
InternalJavaScriptEvaluationFailure: ExitCode
The JavaScript source code internal in Node.js's bootstrapping process failed to return a function value when evaluated.
The JavaScript source code internal in Node.js's bootstrapping process failed to return a function value when evaluated. This is extremely rare, and generally can only happen during development of Node.js itself.
-
val
InternalJavaScriptParseError: ExitCode
The JavaScript source code internal in Node.js's bootstrapping process caused a parse error.
The JavaScript source code internal in Node.js's bootstrapping process caused a parse error. This is extremely rare, and generally can only happen during development of Node.js itself.
-
val
InternalJavaScriptRunTimeFailure: ExitCode
The JavaScript source code internal in Node.js's bootstrapping process threw an error when the bootstrapping function was called.
The JavaScript source code internal in Node.js's bootstrapping process threw an error when the bootstrapping function was called. This is extremely rare, and generally can only happen during development of Node.js itself.
-
val
InvalidArgument: ExitCode
Either an unknown option was specified, or an option requiring a value was provided without a value.
-
val
InvalidDebugArgument: ExitCode
The --debug and/or --debug-brk options were set, but an invalid port number was chosen.
-
val
NonFunctionInternalExceptionHandler: ExitCode
There was an uncaught exception, but the internal fatal exception handler function was somehow set to a non-function, and could not be called.
-
val
SignalExits: ExitCode
If Node.js receives a fatal signal such as SIGKILL or SIGHUP, then its exit code will be 128 plus the value of the signal code.
If Node.js receives a fatal signal such as SIGKILL or SIGHUP, then its exit code will be 128 plus the value of the signal code. This is a standard Unix practice, since exit codes are defined to be 7-bit integers, and signal exits set the high-order bit, and then contain the value of the signal code.
-
val
UncaughtFatalException: ExitCode
There was an uncaught exception, and it was not handled by a domain or an 'uncaughtException' event handler.
-
def
__dirname: String
The directory name of the current module.
The directory name of the current module. This the same as the path.dirname() of the __filename.
-
def
__filename: String
The file name of the current module.
The file name of the current module. This is the resolved absolute path of the current module file. For a main program this is not necessarily the same as the file name used in the command line. See __dirname for the directory name of the current module.
-
implicit
def
duration2Double(duration: FiniteDuration): Double
Implicit conversion to translate durations into a double
Implicit conversion to translate durations into a double
- duration
the given duration
- returns
the time in milliseconds as a double
-
implicit
def
duration2Int(duration: FiniteDuration): Int
Implicit conversion to translate durations into an integer
Implicit conversion to translate durations into an integer
- duration
the given duration
- returns
the time in milliseconds as an integer
-
implicit
def
error2Exception(error: Error): Exception
Implicit conversion to transform Node Errors to Exceptions
-
object
Assert
extends Object with Assert
Assert Singleton
Assert Singleton
- Annotations
- @native() @JSImport( "assert" , JSImport.Namespace )
-
object
Error
extends Object
Error Singleton
Error Singleton
- Annotations
- @native() @JSGlobal()
-
object
Module
Module Companion
-
object
Process
Process Object Companion
-
object
SystemError
extends Error
System Error Singleton
System Error Singleton
- Annotations
- @native() @JSImport( "errors" , JSImport.Namespace )
-
object
clearImmediate
extends Object with ClearImmediate
- Annotations
- @native() @JSGlobal( "clearImmediate" )
-
object
clearInterval
extends Object with ClearInterval
- Annotations
- @native() @JSGlobal( "clearInterval" )
-
object
clearTimeout
extends Object with ClearTimeout
- Annotations
- @native() @JSGlobal( "clearTimeout" )
-
object
console
extends Console
Used to print to stdout and stderr.
Used to print to stdout and stderr. See the console section.
- Annotations
- @native() @JSGlobal( "console" )
-
object
global
extends Object with Global
In browsers, the top-level scope is the global scope.
In browsers, the top-level scope is the global scope. That means that in browsers if you're in the global scope var something will define a global variable. In Node.js this is different. The top-level scope is not the global scope; var something inside a Node.js module will be local to that module.
- Annotations
- @native() @JSGlobal( "global" )
-
object
process
extends Object with Process
The process object.
The process object. See the process object section.
- Annotations
- @native() @JSGlobal( "process" )
-
object
ref
extends Object with Ref
- Annotations
- @native() @JSGlobal( "ref" )
-
object
setImmediate
extends Object with SetImmediate
- Annotations
- @native() @JSGlobal( "setImmediate" )
-
object
setInterval
extends Object with SetInterval
- Annotations
- @native() @JSGlobal( "setInterval" )
-
object
setTimeout
extends Object with SetTimeout
- Annotations
- @native() @JSGlobal( "setTimeout" )
-
object
unref
extends Object with UnRef
- Annotations
- @native() @JSGlobal( "unref" )