Class ApiError

Represents a BrowserFS error. Passed back to applications after a failed call to the BrowserFS API.

Hierarchy

Error
- ApiError

Implements

ErrnoException

Index

Constructors

Properties

cause? code errno message name path? stack? syscall prepareStackTrace? stackTraceLimit

Methods

bufferSize serialize toJSON toString Derserialize EACCES EEXIST EISDIR ENOENT ENOTDIR ENOTEMPTY EPERM FileError captureStackTrace fromJSON

Constructors

constructor

new ApiError(type, message?, path?): ApiError
Represents a BrowserFS error. Passed back to applications after a failed call to the BrowserFS API.

Error codes mirror those returned by regular Unix file operations, which is what Node returns.
Parameters
- type: ErrorCode
  
  The type of the error.
- Optional message: string = ...
  
  A descriptive error message.
- Optional path: string
Returns ApiError
Overrides Error.constructor
- Defined in src/ApiError.ts:126

Properties

`Optional` cause

cause?: unknown

code

code: string

errno

errno: ErrorCode

message

message: string

name

name: string

`Optional` path

path?: string

`Optional` stack

stack?: string

syscall

syscall: string = ''

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

Methods

bufferSize

bufferSize(): number
The size of the API error in buffer-form in bytes.

Returns number
- Defined in src/ApiError.ts:166

serialize

serialize(data?, i?): Uint8Array
Writes the API error into a buffer.
Parameters
- data: ArrayBufferLike | ArrayBufferView = ...
- i: number = 0
Returns Uint8Array
- Defined in src/ApiError.ts:154

toJSON

toJSON(): any
Returns any
- Defined in src/ApiError.ts:141

toString

toString(): string
Returns string
A friendly error message.
- Defined in src/ApiError.ts:137

`Static` Derserialize

Derserialize(data, i?): ApiError
Creates an ApiError object from a buffer.
Parameters
- data: ArrayBufferLike | ArrayBufferView
- i: number = 0
Returns ApiError
- Defined in src/ApiError.ts:71

`Static` EACCES

EACCES(path): ApiError
Parameters
- path: string
Returns ApiError
- Defined in src/ApiError.ts:81

`Static` EEXIST

EEXIST(path): ApiError
Parameters
- path: string
Returns ApiError
- Defined in src/ApiError.ts:89

`Static` EISDIR

EISDIR(path): ApiError
Parameters
- path: string
Returns ApiError
- Defined in src/ApiError.ts:93

`Static` ENOENT

ENOENT(path): ApiError
Parameters
- path: string
Returns ApiError
- Defined in src/ApiError.ts:85

`Static` ENOTDIR

ENOTDIR(path): ApiError
Parameters
- path: string
Returns ApiError
- Defined in src/ApiError.ts:97

`Static` ENOTEMPTY

ENOTEMPTY(path): ApiError
Parameters
- path: string
Returns ApiError
- Defined in src/ApiError.ts:105

`Static` EPERM

EPERM(path): ApiError
Parameters
- path: string
Returns ApiError
- Defined in src/ApiError.ts:101

`Static` FileError

FileError(code, p): ApiError
Parameters
- code: ErrorCode
- p: string
Returns ApiError
- Defined in src/ApiError.ts:77

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

`Static` fromJSON

fromJSON(json): ApiError
Parameters
- json: ApiErrorJSON
Returns ApiError
- Defined in src/ApiError.ts:61

Generated using TypeDoc