Options
All
  • Public
  • Public/Protected
  • All
Menu

Module write

Callable

  • write<TBuffer>(fd: number, buffer: TBuffer, offset: number | undefined | null, length: number | undefined | null, position: number | undefined | null, callback: function): void
  • write<TBuffer>(fd: number, buffer: TBuffer, offset: number | undefined | null, length: number | undefined | null, callback: function): void
  • write<TBuffer>(fd: number, buffer: TBuffer, offset: number | undefined | null, callback: function): void
  • write<TBuffer>(fd: number, buffer: TBuffer, callback: function): void
  • write(fd: number, string: string, position: number | undefined | null, encoding: BufferEncoding | undefined | null, callback: function): void
  • write(fd: number, string: string, position: number | undefined | null, callback: function): void
  • write(fd: number, string: string, callback: function): void

  • Asynchronously writes buffer to the file referenced by the supplied file descriptor.

    Type parameters

    Parameters

    • fd: number

      A file descriptor.

    • buffer: TBuffer
    • offset: number | undefined | null

      The part of the buffer to be written. If not supplied, defaults to 0.

    • length: number | undefined | null

      The number of bytes to write. If not supplied, defaults to buffer.length - offset.

    • position: number | undefined | null

      The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.

    • callback: function
        • (err: ErrnoException | null, written: number, buffer: TBuffer): void

        • Parameters

          Returns void

    Returns void

  • Asynchronously writes buffer to the file referenced by the supplied file descriptor.

    Type parameters

    Parameters

    • fd: number

      A file descriptor.

    • buffer: TBuffer
    • offset: number | undefined | null

      The part of the buffer to be written. If not supplied, defaults to 0.

    • length: number | undefined | null

      The number of bytes to write. If not supplied, defaults to buffer.length - offset.

    • callback: function
        • (err: ErrnoException | null, written: number, buffer: TBuffer): void

        • Parameters

          Returns void

    Returns void

  • Asynchronously writes buffer to the file referenced by the supplied file descriptor.

    Type parameters

    Parameters

    • fd: number

      A file descriptor.

    • buffer: TBuffer
    • offset: number | undefined | null

      The part of the buffer to be written. If not supplied, defaults to 0.

    • callback: function
        • (err: ErrnoException | null, written: number, buffer: TBuffer): void

        • Parameters

          Returns void

    Returns void

  • Asynchronously writes buffer to the file referenced by the supplied file descriptor.

    Type parameters

    Parameters

    • fd: number

      A file descriptor.

    • buffer: TBuffer
    • callback: function
        • (err: ErrnoException | null, written: number, buffer: TBuffer): void

        • Parameters

          Returns void

    Returns void

  • Asynchronously writes string to the file referenced by the supplied file descriptor.

    Parameters

    • fd: number

      A file descriptor.

    • string: string

      A string to write.

    • position: number | undefined | null

      The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.

    • encoding: BufferEncoding | undefined | null

      The expected string encoding.

    • callback: function

        • Parameters

          Returns void

    Returns void

  • Asynchronously writes string to the file referenced by the supplied file descriptor.

    Parameters

    • fd: number

      A file descriptor.

    • string: string

      A string to write.

    • position: number | undefined | null

      The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.

    • callback: function

        • Parameters

          Returns void

    Returns void

  • Asynchronously writes string to the file referenced by the supplied file descriptor.

    Parameters

    • fd: number

      A file descriptor.

    • string: string

      A string to write.

    • callback: function

        • Parameters

          Returns void

    Returns void

Index

Functions

Functions

__promisify__

  • __promisify__<TBuffer>(fd: number, buffer?: TBuffer, offset?: number, length?: number, position?: number | null): Promise<object>
  • __promisify__(fd: number, string: string, position?: number | null, encoding?: BufferEncoding | null): Promise<object>

  • Asynchronously writes buffer to the file referenced by the supplied file descriptor.

    Type parameters

    Parameters

    • fd: number

      A file descriptor.

    • Optional buffer: TBuffer
    • Optional offset: number

      The part of the buffer to be written. If not supplied, defaults to 0.

    • Optional length: number

      The number of bytes to write. If not supplied, defaults to buffer.length - offset.

    • Optional position: number | null

      The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.

    Returns Promise<object>

  • Asynchronously writes string to the file referenced by the supplied file descriptor.

    Parameters

    • fd: number

      A file descriptor.

    • string: string

      A string to write.

    • Optional position: number | null

      The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.

    • Optional encoding: BufferEncoding | null

      The expected string encoding.

    Returns Promise<object>

Generated using TypeDoc