DeviceDriver
Defined in: src/internal/devices.ts:66
A device driver
Type Parameters
Section titled “Type Parameters”TData = any
Properties
Section titled “Properties”name:
string
Defined in: src/internal/devices.ts:70
The name of the device driver
singleton?
Section titled “singleton?”
optionalsingleton?:boolean
Defined in: src/internal/devices.ts:76
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
Section titled “Methods”init()?
Section titled “init()?”
optionalinit(ino,options):DeviceInit<TData>
Defined in: src/internal/devices.ts:82
Initializes a new device.
Parameters
Section titled “Parameters”number
options
Section titled “options”object
Returns
Section titled “Returns”DeviceInit<TData>
Device.data
File operations
Section titled “File operations”close()?
Section titled “close()?”
optionalclose(file):void
Defined in: src/internal/devices.ts:109
Close the device
Parameters
Section titled “Parameters”Device<TData>
Returns
Section titled “Returns”void
read()
Section titled “read()”read(
device,buffer,offset,end):void
Defined in: src/internal/devices.ts:91
Synchronously read from a device.
Parameters
Section titled “Parameters”device
Section titled “device”Device<TData>
buffer
Section titled “buffer”Uint8Array
offset
Section titled “offset”number
number
Returns
Section titled “Returns”void
sync()?
Section titled “sync()?”
optionalsync(device):void
Defined in: src/internal/devices.ts:103
Sync the device
Parameters
Section titled “Parameters”device
Section titled “device”Device<TData>
Returns
Section titled “Returns”void
write()
Section titled “write()”write(
device,buffer,offset):void
Defined in: src/internal/devices.ts:97
Synchronously write to a device
Parameters
Section titled “Parameters”device
Section titled “device”Device<TData>
buffer
Section titled “buffer”Uint8Array
offset
Section titled “offset”number
Returns
Section titled “Returns”void