Merge branch 'main' into snyk-upgrade-3e52fde0ed5755591a9000488a1c5dd9

newrelic · Nov 22, 2022 · 6561c78 · 6561c78
2 parents 2d0ae3b + 21e73ef
commit 6561c78
Show file tree

Hide file tree

Showing 28 changed files with 2,382 additions and 1,855 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -10,7 +10,17 @@ module.exports = {
   plugins: ['jsdoc', 'sonarjs'],
   rules: {
     'consistent-return': 'off',
-    'jsdoc/require-jsdoc': 'off'
+    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/no-undefined-types': [
+      'warn',
+      { definedTypes: ['Logger', 'Agent', 'Shim', 'TraceSegment'] }
+    ]
+  },
+  parserOptions: {
+    ecmaVersion: '2020'
+  },
+  parserOptions: {
+    ecmaVersion: 2020
   },
   ignorePatterns: ['test/versioned-external'],
   overrides: [

diff --git a/api.js b/api.js
@@ -390,6 +390,17 @@ API.prototype.addCustomSpanAttribute = function addCustomSpanAttribute(key, valu
  * `Error` or one of its subtypes, but the API will handle strings and objects
  * that have an attached `.message` or `.stack` property.
  *
+ * An example of using this function is
+ *
+ *    try {
+ *      performSomeTask();
+ *    } catch (err) {
+ *      newrelic.noticeError(
+ *        err,
+ *        {extraInformation: "error already handled in the application"}
+ *      );
+ *    }
+ *
  * NOTE: Errors that are recorded using this method do _not_ obey the
  * `ignore_status_codes` configuration.
  *