style: Require check-types and require-returns-type jsdoc (newrelic#3400)

Author: amychisholm03

api.js

@@ -1937,7 +1937,7 @@ API.prototype.ignoreApdex = function ignoreApdex() {
  *      { role: 'user', content: 'Tell me about Node.js.'}
  *    ]})
  * })
- * @param {Object} context LLM custom attributes context
+ * @param {object} context LLM custom attributes context
  * @param {Function} callback The function to execute in context.
  */
 API.prototype.withLlmCustomAttributes = function withLlmCustomAttributes(context, callback) {

eslint.config.js

@@ -55,7 +55,7 @@ const jsdocConfig = {
   rules: {
     'jsdoc/require-jsdoc': 'off',
     'jsdoc/tag-lines': 'off',
-    'jsdoc/check-types': 'off',
+    'jsdoc/check-types': 'error',
     'jsdoc/no-undefined-types': [
       'warn',
       {
@@ -79,6 +79,7 @@ const jsdocConfig = {
     'jsdoc/check-param-names': 'error',
     'jsdoc/require-param-description': 'error',
     'jsdoc/require-param-type': 'error',
+    'jsdoc/require-returns-type': 'error'
   }
 }
 const jsdocOverrides = {

lib/collector/api.js

@@ -153,7 +153,7 @@ CollectorAPI.prototype._updateEndpoints = function _updateEndpoints(endpoint) {
 /**
  * Connect to the data collector.
  *
- * @param {function} callback A typical error first callback to be invoked
+ * @param {Function} callback A typical error first callback to be invoked
  * upon successful or unsuccessful connection. The second parameter will be
  * an instance of {@link CollectorResponse}.
  *

lib/collector/http-agents.js

@@ -19,7 +19,7 @@ let agentProxyWithKeepAlive = null
 /**
  * Returns an HTTP agent with keep-alive enabled
  *
- * @param {Object} config configuration for HTTP agent
+ * @param {object} config configuration for HTTP agent
  */
 exports.keepAliveAgent = function keepAliveAgent(config) {
   config = config ? config : {}
@@ -45,7 +45,7 @@ exports.keepAliveAgent = function keepAliveAgent(config) {
  * to the proxy server as to how its connection is made
  * with New Relic's servers.
  *
- * @param {Object} config configuration for proxy agent
+ * @param {object} config configuration for proxy agent
  */
 exports.proxyAgent = function proxyAgent(config) {
   if (agentProxyWithKeepAlive !== null) {

lib/harvester.js

@@ -74,7 +74,7 @@ module.exports = class Harvester {
   /**
    * Registers an aggregator with the Harvester instance.
    *
-   * @param {Object} aggregator Aggregator instance
+   * @param {object} aggregator Aggregator instance
    */
   add(aggregator) {
     this.aggregators.push(aggregator)

lib/header-processing.js

@@ -15,8 +15,8 @@ const CONTENT_LENGTH_REGEX = /^Content-Length$/i
  * Queue time is provided by certain providers by stamping the request
  * header with the time the request arrived at the router.
  *
- * @param {Object} logger Logger instance
- * @param {Object} requestHeaders Incoming request headers
+ * @param {object} logger Logger instance
+ * @param {object} requestHeaders Incoming request headers
  */
 function getQueueTime(logger, requestHeaders) {
   const headerValue = requestHeaders[REQUEST_START_HEADER] || requestHeaders[QUEUE_HEADER]
@@ -62,7 +62,7 @@ function convertUnit(time) {
  *
  * If no header is found, returns -1
  *
- * @param {Object} headers Incoming request headers
+ * @param {object} headers Incoming request headers
  */
 function getContentLengthFromHeaders(headers) {
   const contentLength = -1

lib/health-reporter.js

@@ -112,7 +112,7 @@ class HealthReporter {
    * object that has an `agent_control` property which is an instance of
    * {@link AgentControlConfig}.
    * @param {object} [params.logger] A standard logger instance.
-   * @param {function} [params.setInterval] A function to use as `setInterval`.
+   * @param {Function} [params.setInterval] A function to use as `setInterval`.
    * Must return an interval object that supports the `unref()` method.
    */
   constructor({
@@ -217,7 +217,7 @@ class HealthReporter {
    * initiate an immediate write of the status file, and then invoke the
    * provided callback.
    *
-   * @param {function} done Callback to be invoked after the status file has
+   * @param {Function} done Callback to be invoked after the status file has
    * been updated.
    */
   stop(done) {

lib/instrumentation-descriptor.js

@@ -9,7 +9,7 @@ const IdGen = require('./util/idgen')
 const idGen = new IdGen()
 
 /**
- * @typedef {function} InstrumentationOnRequire
+ * @typedef {Function} InstrumentationOnRequire
  * @param {Shim} shim The shim instance to use for the instrumentation.
  * @param {object} resolvedNodule The module being instrumented as returned by
  * Node's `require` function.
@@ -19,7 +19,7 @@ const idGen = new IdGen()
  */
 
 /**
- * @typedef {function} InstrumentationOnError
+ * @typedef {Function} InstrumentationOnError
  * @param {Error|object} error The error thrown by `onRequire` when there was
  * an issue registering the instrumentation.
  */

lib/instrumentation/aws-sdk/util.js

@@ -20,9 +20,9 @@ function grabLastUrlSegment(url = '/') {
 /**
  * Retrieves the db segment params from endpoint and command parameters
  *
- * @param {Object} endpoint instance of ddb endpoint
- * @param {Object} params parameters passed to a ddb command
- * @returns {Object}
+ * @param {object} endpoint instance of ddb endpoint
+ * @param {object} params parameters passed to a ddb command
+ * @returns {object}
  */
 function setDynamoParameters(endpoint, params) {
   return new DatastoreParameters({

lib/instrumentation/aws-sdk/v2/instrumentation-helper.js

@@ -8,7 +8,7 @@
 /**
  * Series of tests to determine if the library
  * has the features needed to provide instrumentation.
- * @param {Object} AWS AWS SDK object
+ * @param {object} AWS AWS SDK object
  */
 const instrumentationSupported = function instrumentationSupported(AWS) {
   // instrumentation requires the serviceClientOperationsMap property