Class ErrorEncryptedFSError<T>

Type Parameters

Hierarchy

ErrorEncryptedFS<T>
- ErrorEncryptedFSError

Index

Constructors

Constructors

constructor

new ErrorEncryptedFSError<T>(__namedParameters, options?): ErrorEncryptedFSError<T>
Type Parameters
- T
Parameters
- __namedParameters: {
      dest?: string;
      errno: {
          code: string;
          description: string;
          errno: number;
      };
      message?: string;
      path?: string;
      syscall?: string;
  }
  - Optional dest?: string
  - errno: {
        code: string;
        description: string;
        errno: number;
    }
    - code: string
    - description: string
    - errno: number
  - Optional message?: string
  - Optional path?: string
  - Optional syscall?: string
- options: {
      cause?: T;
      data?: POJO;
      timestamp?: Date;
  } = {}
  - Optional cause?: T
  - Optional data?: POJO
  - Optional timestamp?: Date
Returns ErrorEncryptedFSError<T>
Overrides ErrorEncryptedFS.constructor
- Defined in src/errors.ts:73

Properties

`Protected` _code

_code: string

`Protected` _description

_description: string

`Protected` _errno

_errno: number

`Protected` `Optional` _syscall

_syscall?: string

cause

cause: T

Causation of the exception Can be used to know what caused this exception

data

data: POJO

Arbitrary data

message

message: string

name

name: string

`Optional` stack

stack?: string

timestamp

timestamp: Date

Timestamp when exception was constructed in milliseconds Guaranteed to be weakly monotonic

`Static` description

description: string = 'EncryptedFS filesystem error'

`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

Accessors

code

get code(): string
Returns string
- Defined in src/errors.ts:125

description

get description(): string
Returns string
Overrides ErrorEncryptedFS.description
- Defined in src/errors.ts:129

errno

get errno(): number
Returns number
- Defined in src/errors.ts:121

syscall

get syscall(): undefined | string
Returns undefined | string
- Defined in src/errors.ts:133

Methods

setPaths

setPaths(src, dst?): void
Parameters
- src: string
- Optional dst: string
Returns void
- Defined in src/errors.ts:111

setSyscall

setSyscall(syscall): void
Parameters
- syscall: string
Returns void
- Defined in src/errors.ts:117

toJSON

toJSON(): any
Encoding to JSON pojo When overriding this, you can use super.toJSON The replacer will:
- delete undefined values in objects
- replace undefined values for null in arrays
Returns any
Overrides ErrorEncryptedFS.toJSON
- Defined in src/errors.ts:137

`Static` captureStackTrace

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

`Static` fromJSON

fromJSON<T>(this, json): InstanceType<T>
Runtime decoding of JSON POJO to exception instance When overriding this, you cannot use super.fromJSON You must write it fully, and use the same type-hacks to support polymorphic this in static methods https://github.com/microsoft/TypeScript/issues/5863
Type Parameters
- T extends Class<any>
Parameters
- this: T
- json: any
Returns InstanceType<T>
Overrides ErrorEncryptedFS.fromJSON
- Defined in src/errors.ts:28

Class ErrorEncryptedFSError<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

__namedParameters: { dest?: string; errno: { code: string; description: string; errno: number; }; message?: string; path?: string; syscall?: string; }

Optional dest?: string

errno: { code: string; description: string; errno: number; }

code: string

description: string

errno: number

Optional message?: string

Optional path?: string

Optional syscall?: string

options: { cause?: T; data?: POJO; timestamp?: Date; } = {}

Optional cause?: T

Optional data?: POJO

Optional timestamp?: Date

Returns ErrorEncryptedFSError<T>

Properties

Protected _code

Protected _description

Protected _errno

Protected Optional _syscall

cause

data

message

name

Optional stack

timestamp

Static description

Static Optional prepareStackTrace

Type declaration

Parameters

err: Error

stackTraces: CallSite[]

Returns any

See

Static stackTraceLimit

Accessors

code

Returns string

description

Returns string

errno

Returns number

syscall

Returns undefined | string

Methods

setPaths

Parameters

src: string

Optional dst: string

Returns void

setSyscall

Parameters

syscall: string

Returns void

toJSON

Returns any

Static captureStackTrace

Parameters

targetObject: object

Optional constructorOpt: Function

Returns void

Static fromJSON

Type Parameters

T extends Class<any>

Parameters

this: T

json: any

__namedParameters: {
dest?: string;
errno: {
code: string;
description: string;
errno: number;
};
message?: string;
path?: string;
syscall?: string;
}

`Optional` dest?: string

errno: {
code: string;
description: string;
errno: number;
}

`Optional` message?: string

`Optional` path?: string

`Optional` syscall?: string

options: {
cause?: T;
data?: POJO;
timestamp?: Date;
} = {}

`Optional` cause?: T

`Optional` data?: POJO

`Optional` timestamp?: Date

`Protected` _code

`Protected` _description

`Protected` _errno

`Protected` `Optional` _syscall

`Optional` stack

`Static` description

`Static` `Optional` prepareStackTrace

`Static` stackTraceLimit

`Optional` dst: string

`Static` captureStackTrace

`Optional` constructorOpt: Function

`Static` fromJSON