FileStream | miniSphere

Provides stream-like access to the raw byte content of a file.

Hierarchy

FileStream

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FileStream(fileName: string, fileOp: FileOp): FileStream

- Defined in lib.sphere.d.ts:833
Parameters
- fileName: string
- fileOp: FileOp
Returns FileStream

Properties

fileName

fileName: string

Full, canonical SphereFS path of the open file.

fileSize

fileSize: number

Current physical size of the open file, in bytes.

position

position: number

Position of the next byte in the file to be read or written, starting at 0.

Methods

asyncRead

asyncRead(numBytes: number): Promise<ArrayBuffer>

- Defined in lib.sphere.d.ts:846
Parameters
- numBytes: number
Returns Promise<ArrayBuffer>

asyncWrite

asyncWrite(data: ArrayBuffer | ArrayBufferView): Promise<void>

- Defined in lib.sphere.d.ts:847
Parameters
- data: ArrayBuffer | ArrayBufferView
Returns Promise<void>

dispose

dispose(): void

- Defined in lib.sphere.d.ts:850
Clean up any resources held by this FileStream after using it.

Returns void

read

read(size: number): ArrayBuffer

- Defined in lib.sphere.d.ts:852
Parameters
- size: number
Returns ArrayBuffer

write

write(data: ArrayBuffer | ArrayBufferView): void

- Defined in lib.sphere.d.ts:853
Parameters
- data: ArrayBuffer | ArrayBufferView
Returns void

Static open

open(fileName: string, fileOp: FileOp): Promise<FileStream>

- Defined in lib.sphere.d.ts:833
Parameters
- fileName: string
- fileOp: FileOp
Returns Promise<FileStream>

Generated using TypeDoc