"buffer" | typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu
                                          *
              MODULES                     *
                                          *

Index

Variables

BuffType

BuffType: object

Type declaration

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

      Parameters

      • str: string

        String to store in buffer.

      • Optional encoding: string

        encoding to use, optional. Default is 'utf8'

      Returns Buffer

    • Allocates a new buffer of {size} octets.

      Parameters

      • size: number

        count of octets to allocate.

      Returns Buffer

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

      Parameters

      • array: Uint8Array

        The octets to store.

      Returns Buffer

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

      Parameters

      • arrayBuffer: ArrayBuffer

        The ArrayBuffer with which to share memory.

      Returns Buffer

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

      Parameters

      • array: any[]

        The octets to store.

      Returns Buffer

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

      Parameters

      • buffer: Buffer

        The buffer to copy.

      Returns Buffer

  • prototype: Buffer
  • alloc: function
    • alloc(size: number, fill?: string | Buffer | number, encoding?: 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: 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, encoding?: 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

        string to test.

      • Optional encoding: string

        encoding used to evaluate (defaults to 'utf8')

      Returns number

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

      Parameters

      Returns number

  • concat: function
    • 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: Buffer[]

        An array of Buffer objects to concatenate

      • Optional totalLength: 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(array: any[]): Buffer
    • from(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer
    • from(buffer: Buffer): Buffer
    • from(str: string, encoding?: string): Buffer
    • Allocates a new Buffer using an {array} of octets.

      Parameters

      • array: any[]

      Returns 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

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

      • Optional byteOffset: number
      • Optional length: number

      Returns Buffer

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

      Parameters

      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: 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
    • 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

INSPECT_MAX_BYTES

INSPECT_MAX_BYTES: number

SlowBuffType

SlowBuffType: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): Buffer
    • new __type(size: number): Buffer
    • new __type(size: Uint8Array): Buffer
    • new __type(array: any[]): Buffer
    • Parameters

      • str: string
      • Optional encoding: string

      Returns Buffer

    • Parameters

      • size: number

      Returns Buffer

    • Parameters

      • size: Uint8Array

      Returns Buffer

    • Parameters

      • array: any[]

      Returns Buffer

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number
    • Parameters

      • string: string
      • Optional encoding: string

      Returns number

  • concat: function
    • Parameters

      • list: Buffer[]
      • Optional totalLength: number

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Parameters

      • obj: any

      Returns boolean

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