Class Err

provides a standardised way of generating log-friendly exception details in either short or full formatting. Usage would look like:

const result1 = Err.handle(() => functionThatThrowsTypeError(arg1, arg2));
const result2 = await Err.handleAsync(() => asyncFunctionThatThrowsArgumentError(arg1, arg2));

which would output:

YYYYMMDD - [AFT] - WARN  - TypeError: [max 100 characters of message...] --- [max 300 characters...of the stack trace]
YYYYMMDD - [AFT] - WARN  - ArgumentError: [max 100 characters of message...] --- [max 300 characters...of the stack trace]

NOTE:

an optional Partial<ErrorOptions> object can be passed to the handle and handleAsync functions allowing you to control the LogLevel used (defaults to 'warn'), the verbosity (defaults to 'short'), and the ReportingManager instance used (defaults to aftLog global instance)

and:

const logger = new ReportingManager('AFT');
try {
    functionThatThrowsTypeError();
} catch (e) {
    await logger.warn(Err.short(e));
    await logger.debug(Err.full(e));
}

which outputs:

YYYYMMDD - [AFT] - WARN - TypeError: [max 100 characters of message...] --- [max 300 characters...of the stack trace]
YYYYMMDD - [AFT] - DEBUG - TypeError: [full type error message and stack trace]
[full stack trace of as much as the Error contained]

Hierarchy

Object
- Err

Constructors

constructor

new Err(error): Err
Parameters
- error: any
Returns Err
Overrides Object.constructor
- Defined in packages/aft-core/src/helpers/err.ts:65

Properties

`Private` _verbosity

_verbosity: ErrVerbosity

constructor

constructor: Function

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

`Readonly` err

err: Error

should

should: Assertion

Accessors

message

get message(): string
the message portion of the Error

Returns string
- Defined in packages/aft-core/src/helpers/err.ts:102

stack

get stack(): string
the stack trace of the Error object

Returns string
- Defined in packages/aft-core/src/helpers/err.ts:109

type

get type(): string
the type of Error

Returns string
- Defined in packages/aft-core/src/helpers/err.ts:95

verbosity

get verbosity(): ErrVerbosity
Returns ErrVerbosity
- Defined in packages/aft-core/src/helpers/err.ts:80

Methods

`Private` _isError

_isError(obj): boolean
Parameters
- obj: any
Returns boolean
- Defined in packages/aft-core/src/helpers/err.ts:125

`Private` _processMessage

_processMessage(message): string
Parameters
- message: string
Returns string
- Defined in packages/aft-core/src/helpers/err.ts:129

`Private` _processStack

_processStack(stack): string
Parameters
- stack: string
Returns string
- Defined in packages/aft-core/src/helpers/err.ts:138

`Private` _removeInternalStackLines

_removeInternalStackLines(stack): string
Parameters
- stack: string
Returns string
- Defined in packages/aft-core/src/helpers/err.ts:150

`Private` _removeNewlinesAndExtraWhitespace

_removeNewlinesAndExtraWhitespace(input): string
Parameters
- input: string
Returns string
- Defined in packages/aft-core/src/helpers/err.ts:162

hasOwnProperty

hasOwnProperty(v): boolean
Determines whether an object has a property with the specified name.
Parameters
- v: PropertyKey
  
  A property name.
Returns boolean
Inherited from Object.hasOwnProperty
- Defined in node_modules/typescript/lib/lib.es5.d.ts:140

isPrototypeOf

isPrototypeOf(v): boolean
Determines whether an object exists in another object's prototype chain.
Parameters
- v: Object
  
  Another object whose prototype chain is to be checked.
Returns boolean
Inherited from Object.isPrototypeOf
- Defined in node_modules/typescript/lib/lib.es5.d.ts:146

propertyIsEnumerable

propertyIsEnumerable(v): boolean
Determines whether a specified property is enumerable.
Parameters
- v: PropertyKey
  
  A property name.
Returns boolean
Inherited from Object.propertyIsEnumerable
- Defined in node_modules/typescript/lib/lib.es5.d.ts:152

setVerbosity

setVerbosity(v): Err
Parameters
- v: ErrVerbosity
Returns Err
- Defined in packages/aft-core/src/helpers/err.ts:87

toLocaleString

toLocaleString(): string
Returns a date converted to a string using the current locale.

Returns string
Inherited from Object.toLocaleString
- Defined in node_modules/typescript/lib/lib.es5.d.ts:131

toString

toString(): string
Returns string
Overrides Object.toString
- Defined in packages/aft-core/src/helpers/err.ts:113

valueOf

valueOf(): Object
Returns the primitive value of the specified object.

Returns Object
Inherited from Object.valueOf
- Defined in node_modules/typescript/lib/lib.es5.d.ts:134

`Static` `Private` _processException

_processException(e, opts?): string
Parameters
- e: Error
- Optional opts: Partial<ErrOptions>
Returns string
- Defined in packages/aft-core/src/helpers/err.ts:228

`Static` assign

assign<T, U>(target, source): T & U
Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.
Type Parameters
- T extends {}
- U
Parameters
- target: T
  
  The target object to copy to.
- source: U
  
  The source object from which to copy properties.
Returns T & U
Inherited from Object.assign
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:284
assign<T, U, V>(target, source1, source2): T & U & V
Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.
Type Parameters
- T extends {}
- U
- V
Parameters
- target: T
  
  The target object to copy to.
- source1: U
  
  The first source object from which to copy properties.
- source2: V
  
  The second source object from which to copy properties.
Returns T & U & V
Inherited from Object.assign
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:293
assign<T, U, V, W>(target, source1, source2, source3): T & U & V & W
Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.
Type Parameters
- T extends {}
- U
- V
- W
Parameters
- target: T
  
  The target object to copy to.
- source1: U
  
  The first source object from which to copy properties.
- source2: V
  
  The second source object from which to copy properties.
- source3: W
  
  The third source object from which to copy properties.
Returns T & U & V & W
Inherited from Object.assign
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:303
assign(target, ...sources): any
Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.
Parameters
- target: object
  
  The target object to copy to.
- Rest ...sources: any[]
  
  One or more source objects from which to copy properties
Returns any
Inherited from Object.assign
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:311

`Static` create

create(o): any
Creates an object that has the specified prototype or that has null prototype.
Parameters
- o: object
  
  Object to use as a prototype. May be null.
Returns any
Inherited from Object.create
- Defined in node_modules/typescript/lib/lib.es5.d.ts:188
create(o, properties): any
Creates an object that has the specified prototype, and that optionally contains specified properties.
Parameters
- o: object
  
  Object to use as a prototype. May be null
- properties: PropertyDescriptorMap & ThisType<any>
  
  JavaScript object that contains one or more property descriptors.
Returns any
Inherited from Object.create
- Defined in node_modules/typescript/lib/lib.es5.d.ts:195

`Static` defineProperties

defineProperties<T>(o, properties): T
Adds one or more properties to an object, and/or modifies attributes of existing properties.
Type Parameters
- T
Parameters
- o: T
  
  Object on which to add or modify the properties. This can be a native JavaScript object or a DOM object.
- properties: PropertyDescriptorMap & ThisType<any>
  
  JavaScript object that contains one or more descriptor objects. Each descriptor object describes a data property or an accessor property.
Returns T
Inherited from Object.defineProperties
- Defined in node_modules/typescript/lib/lib.es5.d.ts:210

`Static` defineProperty

defineProperty<T>(o, p, attributes): T
Adds a property to an object, or modifies attributes of an existing property.
Type Parameters
- T
Parameters
- o: T
  
  Object on which to add or modify the property. This can be a native JavaScript object (that is, a user-defined object or a built in object) or a DOM object.
- p: PropertyKey
  
  The property name.
- attributes: PropertyDescriptor & ThisType<any>
  
  Descriptor for the property. It can be for a data property or an accessor property.
Returns T
Inherited from Object.defineProperty
- Defined in node_modules/typescript/lib/lib.es5.d.ts:203

`Static` entries

entries<T>(o): [string, T][]
Returns an array of key/values of the enumerable properties of an object
Type Parameters
- T
Parameters
- o: {
  [s: string]: T;
  } | ArrayLike<T>
  
  Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
Returns [string, T][]
Inherited from Object.entries
- Defined in node_modules/typescript/lib/lib.es2017.object.d.ts:36
entries(o): [string, any][]
Returns an array of key/values of the enumerable properties of an object
Parameters
- o: {}
  
  Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
Returns [string, any][]
Inherited from Object.entries
- Defined in node_modules/typescript/lib/lib.es2017.object.d.ts:42

`Static` freeze

freeze<T>(f): T
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
Type Parameters
- T extends Function
Parameters
- f: T
  
  Object on which to lock the attributes.
Returns T
Inherited from Object.freeze
- Defined in node_modules/typescript/lib/lib.es5.d.ts:222
freeze<T, U>(o): Readonly<T>
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
Type Parameters
- T extends {
  [idx: string]: U | null | undefined | object;
  }
- U extends string | number | bigint | boolean | symbol
Parameters
- o: T
  
  Object on which to lock the attributes.
Returns Readonly<T>
Inherited from Object.freeze
- Defined in node_modules/typescript/lib/lib.es5.d.ts:228
freeze<T>(o): Readonly<T>
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
Type Parameters
- T
Parameters
- o: T
  
  Object on which to lock the attributes.
Returns Readonly<T>
Inherited from Object.freeze
- Defined in node_modules/typescript/lib/lib.es5.d.ts:234

`Static` fromEntries

fromEntries<T>(entries): {
[k: string]: T;
}
Returns an object created by key-value entries for properties and methods
Type Parameters
- T = any
Parameters
- entries: Iterable<readonly [PropertyKey, T]>
  
  An iterable object that contains key-value entries for properties and methods.
Returns {
[k: string]: T;
}
- [k: string]: T
Inherited from Object.fromEntries
- Defined in node_modules/typescript/lib/lib.es2019.object.d.ts:26
fromEntries(entries): any
Returns an object created by key-value entries for properties and methods
Parameters
- entries: Iterable<readonly any[]>
  
  An iterable object that contains key-value entries for properties and methods.
Returns any
Inherited from Object.fromEntries
- Defined in node_modules/typescript/lib/lib.es2019.object.d.ts:32

`Static` full

full(err): string
Parameters
- err: any
  
  the Error to parse
Returns string
a full length string formatted as
```
Error.name: Error.message
Error.stack
```
where the full Error details are preserved
- Defined in packages/aft-core/src/helpers/err.ts:190

`Static` getOwnPropertyDescriptor

getOwnPropertyDescriptor(o, p): PropertyDescriptor
Gets the own property descriptor of the specified object. An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.
Parameters
- o: any
  
  Object that contains the property.
- p: PropertyKey
  
  Name of the property.
Returns PropertyDescriptor
Inherited from Object.getOwnPropertyDescriptor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:175

`Static` getOwnPropertyDescriptors

getOwnPropertyDescriptors<T>(o): {
[P in string | number | symbol]: TypedPropertyDescriptor<T[P]>
} & {
[x: string]: PropertyDescriptor;
}
Returns an object containing all own property descriptors of an object
Type Parameters
- T
Parameters
- o: T
  
  Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
Returns {
[P in string | number | symbol]: TypedPropertyDescriptor<T[P]>
} & {
[x: string]: PropertyDescriptor;
}
Inherited from Object.getOwnPropertyDescriptors
- Defined in node_modules/typescript/lib/lib.es2017.object.d.ts:48

`Static` getOwnPropertyNames

getOwnPropertyNames(o): string[]
Returns the names of the own properties of an object. The own properties of an object are those that are defined directly on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.
Parameters
- o: any
  
  Object that contains the own properties.
Returns string[]
Inherited from Object.getOwnPropertyNames
- Defined in node_modules/typescript/lib/lib.es5.d.ts:182

`Static` getOwnPropertySymbols

getOwnPropertySymbols(o): symbol[]
Returns an array of all symbol properties found directly on object o.
Parameters
- o: any
  
  Object to retrieve the symbols from.
Returns symbol[]
Inherited from Object.getOwnPropertySymbols
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:317

`Static` getPrototypeOf

getPrototypeOf(o): any
Returns the prototype of an object.
Parameters
- o: any
  
  The object that references the prototype.
Returns any
Inherited from Object.getPrototypeOf
- Defined in node_modules/typescript/lib/lib.es5.d.ts:167

`Static` handle

handle<T>(func, opts?): ProcessingResult<T>
calls the passed in Func<void, T> and handles any errors
Type Parameters
- T
Parameters
- func: Func<void, T>
  
  a function to be run inside a try-catch
- Optional opts: Partial<ErrOptions>
  
  an ErrOptions object containing options for this call
Returns ProcessingResult<T>
a ProcessingResult where result is the output of the passed in func and message will ONLY be set if an error was caught
- Defined in packages/aft-core/src/helpers/err.ts:203

`Static` handleAsync

handleAsync<T>(func, opts?): Promise<ProcessingResult<T>>
calls the passed in Func<void, T | PromiseLike<T>> and handles any errors
Type Parameters
- T
Parameters
- func: Func<void, T | PromiseLike<T>>
  
  an async function to be awaited inside a try-catch
- Optional opts: Partial<ErrOptions>
  
  an ErrOptions object containing options for this call
Returns Promise<ProcessingResult<T>>
a ProcessingResult where result is the output of the passed in func and message will ONLY be set if an error was caught
- Defined in packages/aft-core/src/helpers/err.ts:219

`Static` is

is(value1, value2): boolean
Returns true if the values are the same value, false otherwise.
Parameters
- value1: any
  
  The first value.
- value2: any
  
  The second value.
Returns boolean
Inherited from Object.is
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:330

`Static` isExtensible

isExtensible(o): boolean
Returns a value that indicates whether new properties can be added to an object.
Parameters
- o: any
  
  Object to test.
Returns boolean
Inherited from Object.isExtensible
- Defined in node_modules/typescript/lib/lib.es5.d.ts:258

`Static` isFrozen

isFrozen(o): boolean
Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
Parameters
- o: any
  
  Object to test.
Returns boolean
Inherited from Object.isFrozen
- Defined in node_modules/typescript/lib/lib.es5.d.ts:252

`Static` isSealed

isSealed(o): boolean
Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.
Parameters
- o: any
  
  Object to test.
Returns boolean
Inherited from Object.isSealed
- Defined in node_modules/typescript/lib/lib.es5.d.ts:246

`Static` keys

keys(o): string[]
Returns the names of the enumerable string properties and methods of an object.
Parameters
- o: object
  
  Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
Returns string[]
Inherited from Object.keys
- Defined in node_modules/typescript/lib/lib.es5.d.ts:264
keys(o): string[]
Returns the names of the enumerable string properties and methods of an object.
Parameters
- o: {}
  
  Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
Returns string[]
Inherited from Object.keys
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:323

`Static` preventExtensions

preventExtensions<T>(o): T
Prevents the addition of new properties to an object.
Type Parameters
- T
Parameters
- o: T
  
  Object to make non-extensible.
Returns T
Inherited from Object.preventExtensions
- Defined in node_modules/typescript/lib/lib.es5.d.ts:240

`Static` seal

seal<T>(o): T
Prevents the modification of attributes of existing properties, and prevents the addition of new properties.
Type Parameters
- T
Parameters
- o: T
  
  Object on which to lock the attributes.
Returns T
Inherited from Object.seal
- Defined in node_modules/typescript/lib/lib.es5.d.ts:216

`Static` setPrototypeOf

setPrototypeOf(o, proto): any
Sets the prototype of a specified object o to object proto or null. Returns the object o.
Parameters
- o: any
  
  The object to change its prototype.
- proto: object
  
  The value of the new prototype or null.
Returns any
Inherited from Object.setPrototypeOf
- Defined in node_modules/typescript/lib/lib.es2015.core.d.ts:337

`Static` short

short(err): string
Parameters
- err: any
  
  the Error to parse
Returns string
a shortened string formatted as Error.name: Error.message (max 100 chars) --- Error.stack (max 300 chars) where any newlines, tabs and extra spaces are removed
- Defined in packages/aft-core/src/helpers/err.ts:175

`Static` values

values<T>(o): T[]
Returns an array of values of the enumerable properties of an object
Type Parameters
- T
Parameters
- o: {
  [s: string]: T;
  } | ArrayLike<T>
  
  Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
Returns T[]
Inherited from Object.values
- Defined in node_modules/typescript/lib/lib.es2017.object.d.ts:24
values(o): any[]
Returns an array of values of the enumerable properties of an object
Parameters
- o: {}
  
  Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
Returns any[]
Inherited from Object.values
- Defined in node_modules/typescript/lib/lib.es2017.object.d.ts:30

Class Err

NOTE:

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

error: any

Returns Err

Properties

Private _verbosity

constructor

Readonly err

should

Accessors

message

Returns string

stack

Returns string

type

Returns string

verbosity

Returns ErrVerbosity

Methods

Private _isError

Parameters

obj: any

Returns boolean

Private _processMessage

Parameters

message: string

Returns string

Private _processStack

Parameters

stack: string

Returns string

Private _removeInternalStackLines

Parameters

stack: string

Returns string

Private _removeNewlinesAndExtraWhitespace

Parameters

input: string

Returns string

hasOwnProperty

Parameters

v: PropertyKey

Returns boolean

isPrototypeOf

Parameters

v: Object

Returns boolean

propertyIsEnumerable

Parameters

v: PropertyKey

Returns boolean

setVerbosity

Parameters

v: ErrVerbosity

Returns Err

toLocaleString

Returns string

toString

Returns string

valueOf

Returns Object

Static Private _processException

Parameters

e: Error

Optional opts: Partial<ErrOptions>

Returns string

Static assign

Type Parameters

T extends {}

U

Parameters

`Private` _verbosity

`Readonly` err

`Private` _isError

`Private` _processMessage

`Private` _processStack

`Private` _removeInternalStackLines

`Private` _removeNewlinesAndExtraWhitespace

`Static` `Private` _processException

`Optional` opts: Partial<ErrOptions>

`Static` assign

`Rest` ...sources: any[]

`Static` create

`Static` defineProperties

`Static` defineProperty

`Static` entries

o: {
[s: string]: T;
} | ArrayLike<T>

`Static` freeze

T extends {
[idx: string]: U | null | undefined | object;
}