minor jsdoc fixes (#4855)

* minor jsdoc fixes * Update lib/schema-controller.js Co-authored-by: James Sumners <james@sumners.email> * Update lib/schema-controller.js Co-authored-by: James Sumners <james@sumners.email> --------- Co-authored-by: James Sumners <james@sumners.email>
fastify · Jun 30, 2023 · 253506e · 253506e
1 parent 1b393ad
commit 253506e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/lib/reply.js b/lib/reply.js
@@ -859,7 +859,7 @@ function notFound (reply) {
  * @param {object} context the request context
  * @param {object} data the JSON payload to serialize
  * @param {number} statusCode the http status code
- * @param {string} contentType the reply content type
+ * @param {string} [contentType] the reply content type
  * @returns {string} the serialized payload
  */
 function serialize (context, data, statusCode, contentType) {

diff --git a/lib/schema-controller.js b/lib/schema-controller.js
@@ -100,28 +100,28 @@ class SchemaController {
   /**
    * This method will be called when a validator must be setup.
    * Do not setup the compiler more than once
-   * @param {object} serverOptions: the fastify server option
+   * @param {object} serverOptions the fastify server options
    */
-  setupValidator (serverOption) {
+  setupValidator (serverOptions) {
     const isReady = this.validatorCompiler !== undefined && !this.addedSchemas
     if (isReady) {
       return
     }
-    this.validatorCompiler = this.getValidatorBuilder()(this.schemaBucket.getSchemas(), serverOption.ajv)
+    this.validatorCompiler = this.getValidatorBuilder()(this.schemaBucket.getSchemas(), serverOptions.ajv)
   }
 
   /**
    * This method will be called when a serializer must be setup.
    * Do not setup the compiler more than once
-   * @param {object} serverOptions: the fastify server option
+   * @param {object} serverOptions the fastify server options
    */
-  setupSerializer (serverOption) {
+  setupSerializer (serverOptions) {
     const isReady = this.serializerCompiler !== undefined && !this.addedSchemas
     if (isReady) {
       return
     }
 
-    this.serializerCompiler = this.getSerializerBuilder()(this.schemaBucket.getSchemas(), serverOption.serializerOpts)
+    this.serializerCompiler = this.getSerializerBuilder()(this.schemaBucket.getSchemas(), serverOptions.serializerOpts)
   }
 }
 

diff --git a/lib/schemas.js b/lib/schemas.js
@@ -147,8 +147,8 @@ function getSchemaAnyway (schema, jsonShorthand) {
  *
  * @param {object} context the request context
  * @param {number} statusCode the http status code
- * @param {string} contentType the reply content type
- * @returns {function|boolean} the right JSON Schema function to serialize
+ * @param {string} [contentType] the reply content type
+ * @returns {function|false} the right JSON Schema function to serialize
  * the reply or false if it is not set
  */
 function getSchemaSerializer (context, statusCode, contentType) {