Interface DeviceDriver<TData>

A device driver

interface DeviceDriver<TData> {
    isBuffered?: boolean;
    name: string;
    close?(file: DeviceFile): void;
    init?(ino: bigint): {
        data?: TData;
        major?: number;
        minor?: number;
    };
    read(file: DeviceFile, buffer: ArrayBufferView, offset?: number, length?: number, position?: number): number;
    sync?(file: DeviceFile): void;
    write(file: DeviceFile, buffer: Uint8Array, offset: number, length: number, position?: number): number;
}

Type Parameters

  • TData = any

Properties

isBuffered? name

Methods

init?

File operations

close? read sync? write

Properties

OptionalisBuffered

isBuffered?: boolean

Whether the device is buffered (a "block" device) or unbuffered (a "character" device)

Default

false

name

name: string

The name of the device driver

Methods

Optionalinit

  • init(ino): {
        data?: TData;
        major?: number;
        minor?: number;
    }
  • Experimental

    Initializes a new device.

    Parameters

    • ino: bigint

    Returns {
        data?: TData;
        major?: number;
        minor?: number;
    }

    Device.data

    • Optional Experimentaldata?: TData
    • Optional Experimentalmajor?: number
    • Optional Experimentalminor?: number

File operations

Optionalclose

read

  • read(file, buffer, offset?, length?, position?): number

  • Synchronously read from the device

    Parameters

    • file: DeviceFile
    • buffer: ArrayBufferView
    • Optionaloffset: number
    • Optionallength: number
    • Optionalposition: number

    Returns number

Optionalsync

write

  • write(file, buffer, offset, length, position?): number

  • Synchronously write to the device

    Parameters

    • file: DeviceFile
    • buffer: Uint8Array
    • offset: number
    • length: number
    • Optionalposition: number

    Returns number

Settings

Member Visibility

On This Page

Properties
Methods
File operations