Interface DeviceDriver<TData>

A device driver

interface DeviceDriver<TData = any> {
    name: string;
    singleton?: boolean;
    close(file: Device<TData>): void;
    init(ino: number, options: object): DeviceInit<TData>;
    read(
        device: Device<TData>,
        buffer: Uint8Array,
        offset: number,
        end: number,
    ): void;
    sync(device: Device<TData>): void;
    write(device: Device<TData>, buffer: Uint8Array, offset: number): void;
}

Type Parameters

  • TData = any

Properties

name singleton?

Methods

init?

File operations

close? read sync? write

Properties

name

name: string

The name of the device driver

Optionalsingleton

singleton?: boolean

If true, only a single device can exist per device FS. Note that if this is unset or false, auto-named devices will have a number suffix

Methods

Optionalinit

File operations

Optionalclose

read

  • read(
        device: Device<TData>,
        buffer: Uint8Array,
        offset: number,
        end: number,
    ): void

    Synchronously read from a device.

    Parameters

    • device: Device<TData>
    • buffer: Uint8Array
    • offset: number
    • end: number

    Returns void

Optionalsync

write

Settings

Member Visibility

On This Page

Properties
Methods
File operations