Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Global
    • ExtendedGlobalObject

Index

Properties

Array

Array: ArrayConstructor

ArrayBuffer

ArrayBuffer: ArrayBufferConstructor

Boolean

Boolean: BooleanConstructor

Buffer

Buffer: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: undefined | string): Buffer
    • new __type(size: number): Buffer
    • new __type(array: Uint8Array): Buffer
    • new __type(arrayBuffer: ArrayBuffer | SharedArrayBuffer): Buffer
    • new __type(array: any[]): Buffer
    • new __type(buffer: Buffer): Buffer
    • Allocates a new buffer containing the given {str}.

      deprecated

      since v10.0.0 - Use Buffer.from(string[, encoding]) instead.

      Parameters

      • str: string

        String to store in buffer.

      • Optional encoding: undefined | string

        encoding to use, optional. Default is 'utf8'

      Returns Buffer

    • Allocates a new buffer of {size} octets.

      deprecated

      since v10.0.0 - Use Buffer.alloc() instead (also see Buffer.allocUnsafe()).

      Parameters

      • size: number

        count of octets to allocate.

      Returns Buffer

    • Allocates a new buffer containing the given {array} of octets.

      deprecated

      since v10.0.0 - Use Buffer.from(array) instead.

      Parameters

      • array: Uint8Array

        The octets to store.

      Returns Buffer

    • Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}/{SharedArrayBuffer}.

      deprecated

      since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]]) instead.

      Parameters

      • arrayBuffer: ArrayBuffer | SharedArrayBuffer

        The ArrayBuffer with which to share memory.

      Returns Buffer

    • Allocates a new buffer containing the given {array} of octets.

      deprecated

      since v10.0.0 - Use Buffer.from(array) instead.

      Parameters

      • array: any[]

        The octets to store.

      Returns Buffer

    • Copies the passed {buffer} data onto a new {Buffer} instance.

      deprecated

      since v10.0.0 - Use Buffer.from(buffer) instead.

      Parameters

      • buffer: Buffer

        The buffer to copy.

      Returns Buffer

  • poolSize: number

    This is the number of bytes used to determine the size of pre-allocated, internal Buffer instances used for pooling. This value may be modified.

  • prototype: Buffer
  • alloc: function
    • alloc(size: number, fill?: string | Buffer | number, encoding?: undefined | string): Buffer
    • Allocates a new buffer of {size} octets.

      Parameters

      • size: number

        count of octets to allocate.

      • Optional fill: string | Buffer | number

        if specified, buffer will be initialized by calling buf.fill(fill). If parameter is omitted, buffer will be filled with zeros.

      • Optional encoding: undefined | string

        encoding used for call to buf.fill while initalizing

      Returns Buffer

  • allocUnsafe: function
    • allocUnsafe(size: number): Buffer
    • Allocates a new buffer of {size} octets, leaving memory not initialized, so the contents of the newly created Buffer are unknown and may contain sensitive data.

      Parameters

      • size: number

        count of octets to allocate

      Returns Buffer

  • allocUnsafeSlow: function
    • allocUnsafeSlow(size: number): Buffer
    • Allocates a new non-pooled buffer of {size} octets, leaving memory not initialized, so the contents of the newly created Buffer are unknown and may contain sensitive data.

      Parameters

      • size: number

        count of octets to allocate

      Returns Buffer

  • byteLength: function
    • byteLength(string: string | NodeJS.TypedArray | DataView | ArrayBuffer | SharedArrayBuffer, encoding?: undefined | string): number
    • Gives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.

      Parameters

      • string: string | NodeJS.TypedArray | DataView | ArrayBuffer | SharedArrayBuffer

        string to test.

      • Optional encoding: undefined | string

        encoding used to evaluate (defaults to 'utf8')

      Returns number

  • compare: function
    • compare(buf1: Uint8Array, buf2: Uint8Array): number
    • The same as buf1.compare(buf2).

      Parameters

      • buf1: Uint8Array
      • buf2: Uint8Array

      Returns number

  • concat: function
    • concat(list: Uint8Array[], totalLength?: undefined | number): Buffer
    • Returns a buffer which is the result of concatenating all the buffers in the list together.

      If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. If the list has exactly one item, then the first item of the list is returned. If the list has more than one item, then a new Buffer is created.

      Parameters

      • list: Uint8Array[]

        An array of Buffer objects to concatenate

      • Optional totalLength: undefined | number

        Total length of the buffers when concatenated. If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.

      Returns Buffer

  • from: function
    • from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: undefined | number, length?: undefined | number): Buffer
    • from(data: any[]): Buffer
    • from(data: Uint8Array): Buffer
    • from(str: string, encoding?: undefined | string): Buffer
    • When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share the same allocated memory as the TypedArray. The optional {byteOffset} and {length} arguments specify a memory range within the {arrayBuffer} that will be shared by the Buffer.

      Parameters

      • arrayBuffer: ArrayBuffer | SharedArrayBuffer

        The .buffer property of any TypedArray or a new ArrayBuffer()

      • Optional byteOffset: undefined | number
      • Optional length: undefined | number

      Returns Buffer

    • Creates a new Buffer using the passed {data}

      Parameters

      • data: any[]

        data to create a new Buffer

      Returns Buffer

    • Parameters

      • data: Uint8Array

      Returns Buffer

    • Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.

      Parameters

      • str: string
      • Optional encoding: undefined | string

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Returns true if {obj} is a Buffer

      Parameters

      • obj: any

        object to test.

      Returns boolean

  • isEncoding: function
    • isEncoding(encoding: string): boolean | undefined
    • Returns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

      Parameters

      • encoding: string

        string to test.

      Returns boolean | undefined

  • of: function
    • of(...items: number[]): Buffer
    • Creates a new Buffer using the passed {data}

      Parameters

      • Rest ...items: number[]

      Returns Buffer

DataView

DataView: DataViewConstructor

Date

Date: DateConstructor

Error

Error: ErrorConstructor

EvalError

EvalError: EvalErrorConstructor

Float32Array

Float32Array: Float32ArrayConstructor

Float64Array

Float64Array: Float64ArrayConstructor

Function

Function: FunctionConstructor

GLOBAL

GLOBAL: Global

Optional Ifto

Ifto: Ifto

Infinity

Infinity: number

Int16Array

Int16Array: Int16ArrayConstructor

Int32Array

Int32Array: Int32ArrayConstructor

Int8Array

Int8Array: Int8ArrayConstructor

Intl

Intl: Intl

JSON

JSON: JSON

Map

Map: MapConstructor

Math

Math: Math

NaN

NaN: number

Number

Number: NumberConstructor

Object

Object: ObjectConstructor

Promise

Promise: Function

RangeError

RangeError: RangeErrorConstructor

ReferenceError

ReferenceError: ReferenceErrorConstructor

RegExp

RegExp: RegExpConstructor

Set

Set: SetConstructor

String

String: StringConstructor

Symbol

Symbol: Function

SyntaxError

SyntaxError: SyntaxErrorConstructor

TypeError

TypeError: TypeErrorConstructor

URIError

URIError: URIErrorConstructor

Uint16Array

Uint16Array: Uint16ArrayConstructor

Uint32Array

Uint32Array: Uint32ArrayConstructor

Uint8Array

Uint8Array: Uint8ArrayConstructor

Uint8ClampedArray

Uint8ClampedArray: Function

WeakMap

WeakMap: WeakMapConstructor

WeakSet

WeakSet: WeakSetConstructor

clearImmediate

clearImmediate: function

Type declaration

    • (immediateId: Immediate): void
    • Parameters

      • immediateId: Immediate

      Returns void

clearInterval

clearInterval: function

Type declaration

    • (intervalId: Timeout): void
    • Parameters

      • intervalId: Timeout

      Returns void

clearTimeout

clearTimeout: function

Type declaration

    • (timeoutId: Timeout): void
    • Parameters

      • timeoutId: Timeout

      Returns void

console

console: Console

decodeURI

decodeURI: decodeURI

decodeURIComponent

decodeURIComponent: decodeURIComponent

encodeURI

encodeURI: encodeURI

encodeURIComponent

encodeURIComponent: encodeURIComponent

escape

escape: function

Type declaration

    • (str: string): string
    • Parameters

      • str: string

      Returns string

eval

eval: eval

gc

gc: function

Type declaration

    • (): void
    • Returns void

global

global: Global

isFinite

isFinite: isFinite

isNaN

isNaN: isNaN

parseFloat

parseFloat: parseFloat

parseInt

parseInt: parseInt

process

process: Process

root

root: Global

setImmediate

setImmediate: function

Type declaration

    • (callback: function, ...args: any[]): Immediate
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • Rest ...args: any[]

      Returns Immediate

setInterval

setInterval: function

Type declaration

    • (callback: function, ms: number, ...args: any[]): Timeout
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • ms: number
      • Rest ...args: any[]

      Returns Timeout

setTimeout

setTimeout: function

Type declaration

    • (callback: function, ms: number, ...args: any[]): Timeout
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • ms: number
      • Rest ...args: any[]

      Returns Timeout

undefined

undefined: undefined

unescape

unescape: function

Type declaration

    • (str: string): string
    • Parameters

      • str: string

      Returns string

Optional v8debug

v8debug: any

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc