Packages

object Util extends Object with Util

Util Singleton

Annotations
@native() @JSImport( "util" , JSImport.Namespace )
Linear Supertypes
Util, IEventEmitter, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Util
  2. Util
  3. IEventEmitter
  4. Object
  5. Any
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addListener(eventName: String, listener: Function): Util.this.type

    Alias for emitter.on(eventName, listener).

    Alias for emitter.on(eventName, listener).

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.addListener(eventName, listener)

    See also

    on()

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def debuglog(section: String): Function

    This is used to create a function which conditionally writes to stderr based on the existence of a NODE_DEBUG environment variable.

    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 be similar to console.error(). If not, then the returned function is a no-op.

    Definition Classes
    Util
    Example:

    1. util.debuglog(section)

  8. def deprecate(function: Function, string: String): Any

    Marks that a method should not be used any more.

    Marks that a method should not be used any more.

    Definition Classes
    Util
    Example:

    1. util.deprecate(function, string)

  9. val domain: String
    Definition Classes
    IEventEmitter
  10. 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
    Example:

    1. emitter.emit(name[, arg1][, arg2][, ...])

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def format(format: Any*): String

    Returns a formatted string using the first argument as a printf-like format.

    Returns a formatted string using the first argument as a printf-like format.

    Definition Classes
    Util
    Example:

    1. util.format(format[, ...])

  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  16. 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
    Example:

    1. emitter.getMaxListeners()

    See also

    setMaxListeners()

  17. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. def inherits(constructor: Any, superConstructor: Any): Any

    Inherit the prototype methods from one constructor into another.

    Inherit the prototype methods from one constructor into another. The prototype of constructor will be set to a new object created from superConstructor.

    As an additional convenience, superConstructor will be accessible through the constructor.super_ property.

    Definition Classes
    Util
    Example:

    1. util.inherits(constructor, superConstructor)

  20. def inspect(object: Any, options: |[InspectOptions, RawOptions] = js.native): Stats

    The util.inspect() method returns a string representation of object that is primarily useful for debugging.

    The util.inspect() method returns a string representation of object that is primarily useful for debugging. Additional options may be passed that alter certain aspects of the formatted string.

    options

    the given inspect options

    Definition Classes
    Util
    Example:

    1. util.inspect(object[, options])

  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  23. 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
    Example:

    1. emitter.listenerCount(eventName)

  24. 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
    Example:

    1. emitter.listeners(eventName)

  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  28. def on(eventName: String, listener: Function): Util.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
    Example:

    1. emitter.on(eventName, listener)

  29. def once(eventName: String, listener: Function): Util.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
    Example:

    1. emitter.once(eventName, listener)

  30. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  31. def removeAllListeners(): Util.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
    Example:

    1. emitter.removeAllListeners([eventName])

  32. def removeAllListeners(eventName: String): Util.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
    Example:

    1. emitter.removeAllListeners([eventName])

  33. def removeListener(eventName: String, listener: Function): Util.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
    Example:

    1. emitter.removeListener(eventName, listener)

  34. def setMaxListeners(n: Int): Util.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
    Example:

    1. emitter.setMaxListeners(n)

  35. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  36. def toLocaleString(): String
    Definition Classes
    Object
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. val usingDomains: Boolean
    Definition Classes
    IEventEmitter
  39. def valueOf(): Any
    Definition Classes
    Object
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def _extend[A <: Any, B <: Any, C <: Any](target: A, source: B): C

    The util._extend() method was never intended to be used outside of internal Node.js modules.

    The util._extend() method was never intended to be used outside of internal Node.js modules. The community found and used it anyway. It is deprecated and should not be used in new code. JavaScript comes with very similar built-in functionality through Object.assign().

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 6.0.0) Use Object.assign() instead.

    Example:

    1. util._extend(target, source)

  2. def debug(string: String): Any

    Deprecated predecessor of console.error.

    Deprecated predecessor of console.error.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Use console.debug() instead.

    Example:

    1. util.debug(string)

  3. def error(varargs: Any*): Any

    Deprecated predecessor of console.error.

    Deprecated predecessor of console.error.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Use console.error() instead.

    Example:

    1. util.error([...])

  4. def isArray(object: Any): Boolean

    Returns true if the given "object" is an Array.

    Returns true if the given "object" is an Array. Otherwise, returns false.

    NOTEInternal alias for Array.isArray.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Internal alias for Array.isArray.

    Example:

    1. util.isArray(object)

  5. def isBoolean(object: Any): Boolean

    Returns true if the given "object" is a Boolean.

    Returns true if the given "object" is a Boolean. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isBoolean(object)

  6. def isBuffer(object: Any): Boolean

    Returns true if the given "object" is a Buffer.

    Returns true if the given "object" is a Buffer. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Use Buffer.isBuffer() instead.

    Example:

    1. util.isBuffer(object)

  7. def isDate(object: Any): Boolean

    Returns true if the given "object" is a Date.

    Returns true if the given "object" is a Date. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isDate(object)

  8. def isError(object: Any): Boolean

    Returns true if the given "object" is an Error.

    Returns true if the given "object" is an Error. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isError(object)

  9. def isFunction(object: Any): Boolean

    Returns true if the given "object" is a Function.

    Returns true if the given "object" is a Function. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isFunction(object)

  10. def isNull(object: Any): Boolean

    Returns true if the given "object" is strictly null.

    Returns true if the given "object" is strictly null. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isNull(object)

  11. def isNullOrUndefined(object: Any): Boolean

    Returns true if the given "object" is null or undefined.

    Returns true if the given "object" is null or undefined. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isNullOrUndefined(object)

  12. def isNumber(object: Any): Boolean

    Returns true if the given "object" is a Number.

    Returns true if the given "object" is a Number. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isNumber(object)

  13. def isObject(object: Any): Boolean

    Returns true if the given "object" is strictly an Object and not a Function.

    Returns true if the given "object" is strictly an Object and not a Function. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isObject(object)

  14. def isPrimitive(object: Any): Boolean

    Returns true if the given "object" is a primitive type.

    Returns true if the given "object" is a primitive type. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isPrimitive(object)

  15. def isRegExp(object: Any): Boolean

    Returns true if the given "object" is a RegExp.

    Returns true if the given "object" is a RegExp. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isRegExp(object)

  16. def isString(object: Any): Boolean

    Returns true if the given "object" is a String.

    Returns true if the given "object" is a String. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isString(object)

  17. def isSymbol(object: Any): Boolean

    Returns true if the given "object" is a Symbol.

    Returns true if the given "object" is a Symbol. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isSymbol(object)

  18. def isUndefined(object: Any): Boolean

    Returns true if the given "object" is undefined.

    Returns true if the given "object" is undefined. Otherwise, returns false.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Alternative not specified

    Example:

    1. util.isUndefined(object)

  19. def log(message: String): Unit

    Output with timestamp on stdout.

    Output with timestamp on stdout.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 6.0.0) Use a third party module instead.

    Example:

    1. util.log(string)

  20. def print(args: Array[Any]): Unit

    Deprecated predecessor of console.log.

    Deprecated predecessor of console.log.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.3) Use console.log() instead

    Example:

    1. util.print([...])

  21. def pump(readableStream: Readable, Writable: Writable, callback: Function): Unit

    Deprecated predecessor of stream.pipe().

    Deprecated predecessor of stream.pipe().

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 4.0.0) Use ReadableStream.pipe(Writable)

    Example:

    1. util.pump(readableStream, Writable[, callback])

  22. def puts(args: |[Array[String], String]*): Unit

    Deprecated predecessor of console.log.

    Deprecated predecessor of console.log.

    Definition Classes
    Util
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.3) Use console.log() instead.

    Example:

    1. util.puts([...])

Inherited from Util

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped