@availity/exceptions-core v4.1.2

Availity Exceptions

A package to catch errors in apps and logs a formatted stack trace. Can grab some information from global error events, or more data if using the AvExceptions.submitError function.

Install

npm install @availity/exceptions-core

Configure

AvExceptions requires a logging function to call. And its recommended to have code in place to call AvExceptions.submitError(error) for better stack traces.

import AvExceptions from '@availity/exceptions-core';

function exampleLogging(logMessage) {
  // send to api
}

const ExampleExceptions = new AvExceptions(exampleLogging);

Log function

The log function will receive a message object with these keys:

• errorDate - a formatted date string
• errorName - the name from the error object.
• errorMessage - the message from the error object.
• errorStack - a formatted stack trace string
• appId - the defined appId or 'N/A'
• totalHits: how many times this error message has occurred since page load
• currentHits: how many times this error message has occurred since last log
• userAgent - browsers userAgent
• userLanguage - language value from browser
• referrer - document referrer
• host - current domain
• url
• appVersion
• sdkVersion

Methods

submitError

accepts an error object and submits it to be formatted and logged.

enabled

if a value is passed in, sets class's enabled flag true/false based on value.

returns boolean enabled flag value.

if class is not enabled, it will not call the log function.

appId

if a string or number value is passed in, sets appId value.

returns appId.

if no appId is defined, 'N/A' will be in the message object

repeatTime

repeat time is the time AvExceptions will wait after an error is called before it will log another error with the same message.

if a number is passed in, this sets repeat time value. The default is 5 seconds.

returns repeatTime value.

Authors

Kasey Powers

• kaseyepowers@gmail.com

License

MIT