changed the object schema paramter to boolean flag schemaHide

README.md

@@ -38,11 +38,11 @@ Default: `'/'`
 
 A URL path prefix used to create a virtual mount path for the static directory.
 
-#### `schema`
+#### `schemaHide`
 
-Default: `{}`
+Default: `true`
 
-An object that spececify the fastify schema route for all routes.
+A flag that define if the fastify route hide-schema attribute is hidden or not
 
 #### `setHeaders`
 

index.js

@@ -79,7 +79,7 @@ function fastifyStatic (fastify, opts, next) {
 
   if (opts.prefix === undefined) opts.prefix = '/'
   const prefix = opts.prefix[opts.prefix.length - 1] === '/' ? opts.prefix : (opts.prefix + '/')
-  const schema = opts.schema ? { schema: opts.schema } : {} // Perform the check if set a schema or as an empty object
+  const schema = { schema: { hide: typeof opts.schemaHide !== 'undefined' ? opts.schemaHide : true } } // Set the schema hide property if defined in opts or true by default
 
   fastify.get(prefix + '*', schema, function (req, reply) {
     pumpSendToReply(req, reply, '/' + req.params['*'])

test/static.test.js

@@ -716,13 +716,13 @@ t.test('with fastify-compress', t => {
   })
 })
 
-t.test('register /static/ with schema', t => {
+t.test('register /static/ with schemaHide true', t => {
   t.plan(3)
 
   const pluginOptions = {
     root: path.join(__dirname, '/static'),
     prefix: '/static/',
-    schema: { hide: true }
+    schemaHide: true
   }
 
   const fastify = Fastify()
@@ -755,7 +755,46 @@ t.test('register /static/ with schema', t => {
   })
 })
 
-t.test('register /static/ without schema', t => {
+t.test('register /static/ with schemaHide false', t => {
+  t.plan(3)
+
+  const pluginOptions = {
+    root: path.join(__dirname, '/static'),
+    prefix: '/static/',
+    schemaHide: false
+  }
+
+  const fastify = Fastify()
+  fastify.register(fastifyStatic, pluginOptions)
+
+  fastify.addHook('onRoute', function (routeOptions) {
+    t.deepEqual(routeOptions.schema, { hide: false })
+  })
+
+  t.tearDown(fastify.close.bind(fastify))
+
+  fastify.listen(0, err => {
+    t.error(err)
+
+    fastify.server.unref()
+
+    t.test('/static/index.html', t => {
+      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
+
+      simple.concat({
+        method: 'GET',
+        url: 'http://localhost:' + fastify.server.address().port + '/static/index.html'
+      }, (err, response, body) => {
+        t.error(err)
+        t.strictEqual(response.statusCode, 200)
+        t.strictEqual(body.toString(), indexContent)
+        genericResponseChecks(t, response)
+      })
+    })
+  })
+})
+
+t.test('register /static/ without schemaHide', t => {
   t.plan(3)
 
   const pluginOptions = {
@@ -767,7 +806,7 @@ t.test('register /static/ without schema', t => {
   fastify.register(fastifyStatic, pluginOptions)
 
   fastify.addHook('onRoute', function (routeOptions) {
-    t.deepEqual(routeOptions.schema, null)
+    t.deepEqual(routeOptions.schema, { hide: true })
   })
 
   t.tearDown(fastify.close.bind(fastify))