Class ErrnoError

An error with additional information about what happened

Hierarchy

Error
- ErrnoError

Implements

ErrnoException

Index

Constructors

Properties

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

Methods

bufferSize toJSON toString captureStackTrace fromJSON With

Constructors

constructor

new ErrnoError(errno, message?, path?, syscall?): ErrnoError
Parameters
- errno: Errno
  The kind of error
- message: string = ...
  A descriptive error message
- Optionalpath: string
- syscall: string = ''
Returns ErrnoError
Overrides Error.constructor
- Defined in src/error.ts:265

Properties

`Optional`cause

cause?: unknown

code

code:
    | "EPERM"
    | "ENOENT"
    | "EINTR"
    | "EIO"
    | "ENXIO"
    | "EBADF"
    | "EAGAIN"
    | "ENOMEM"
    | "EACCES"
    | "EFAULT"
    | "ENOTBLK"
    | "EBUSY"
    | "EEXIST"
    | "EXDEV"
    | "ENODEV"
    | "ENOTDIR"
    | "EISDIR"
    | "EINVAL"
    | "ENFILE"
    | "EMFILE"
    | "ETXTBSY"
    | "EFBIG"
    | "ENOSPC"
    | "ESPIPE"
    | "EROFS"
    | "EMLINK"
    | "EPIPE"
    | "EDOM"
    | "ERANGE"
    | "EDEADLK"
    | "ENAMETOOLONG"
    | "ENOLCK"
    | "ENOSYS"
    | "ENOTEMPTY"
    | "ELOOP"
    | "ENOMSG"
    | "EBADE"
    | "EBADR"
    | "EXFULL"
    | "ENOANO"
    | "EBADRQC"
    | "ENOSTR"
    | "ENODATA"
    | "ETIME"
    | "ENOSR"
    | "ENONET"
    | "EREMOTE"
    | "ENOLINK"
    | "ECOMM"
    | "EPROTO"
    | "EBADMSG"
    | "EOVERFLOW"
    | "EBADFD"
    | "ESTRPIPE"
    | "ENOTSOCK"
    | "EDESTADDRREQ"
    | "EMSGSIZE"
    | "EPROTOTYPE"
    | "ENOPROTOOPT"
    | "EPROTONOSUPPORT"
    | "ESOCKTNOSUPPORT"
    | "ENOTSUP"
    | "ENETDOWN"
    | "ENETUNREACH"
    | "ENETRESET"
    | "ETIMEDOUT"
    | "ECONNREFUSED"
    | "EHOSTDOWN"
    | "EHOSTUNREACH"
    | "EALREADY"
    | "EINPROGRESS"
    | "ESTALE"
    | "EREMOTEIO"
    | "EDQUOT"

errno

errno: Errno

The kind of error

message

message: string

name

name: string

`Optional`path

path?: string

stack

stack: string

syscall

syscall: string = ''

`Static` `Optional`prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

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/error.ts:303

toJSON

toJSON(): ErrnoErrorJSON
Returns ErrnoErrorJSON
- Defined in src/error.ts:289

toString

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

`Static`captureStackTrace

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

`Static`fromJSON

fromJSON(json): ErrnoError
Parameters
- json: ErrnoErrorJSON
Returns ErrnoError
- Defined in src/error.ts:250

`Static`With

With(code, path?, syscall?): ErrnoError
Parameters
- code:
      | "EPERM"
      | "ENOENT"
      | "EINTR"
      | "EIO"
      | "ENXIO"
      | "EBADF"
      | "EAGAIN"
      | "ENOMEM"
      | "EACCES"
      | "EFAULT"
      | "ENOTBLK"
      | "EBUSY"
      | "EEXIST"
      | "EXDEV"
      | "ENODEV"
      | "ENOTDIR"
      | "EISDIR"
      | "EINVAL"
      | "ENFILE"
      | "EMFILE"
      | "ETXTBSY"
      | "EFBIG"
      | "ENOSPC"
      | "ESPIPE"
      | "EROFS"
      | "EMLINK"
      | "EPIPE"
      | "EDOM"
      | "ERANGE"
      | "EDEADLK"
      | "ENAMETOOLONG"
      | "ENOLCK"
      | "ENOSYS"
      | "ENOTEMPTY"
      | "ELOOP"
      | "ENOMSG"
      | "EBADE"
      | "EBADR"
      | "EXFULL"
      | "ENOANO"
      | "EBADRQC"
      | "ENOSTR"
      | "ENODATA"
      | "ETIME"
      | "ENOSR"
      | "ENONET"
      | "EREMOTE"
      | "ENOLINK"
      | "ECOMM"
      | "EPROTO"
      | "EBADMSG"
      | "EOVERFLOW"
      | "EBADFD"
      | "ESTRPIPE"
      | "ENOTSOCK"
      | "EDESTADDRREQ"
      | "EMSGSIZE"
      | "EPROTOTYPE"
      | "ENOPROTOOPT"
      | "EPROTONOSUPPORT"
      | "ESOCKTNOSUPPORT"
      | "ENOTSUP"
      | "ENETDOWN"
      | "ENETUNREACH"
      | "ENETRESET"
      | "ETIMEDOUT"
      | "ECONNREFUSED"
      | "EHOSTDOWN"
      | "EHOSTUNREACH"
      | "EALREADY"
      | "EINPROGRESS"
      | "ESTALE"
      | "EREMOTEIO"
      | "EDQUOT"
- Optionalpath: string
- Optionalsyscall: string
Returns ErrnoError
- Defined in src/error.ts:257