chore: update server plugin documentation (#31)

digidem · Oct 17, 2024 · 96c7261 · 96c7261
1 parent 3a83caf
commit 96c7261
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/lib/server.js b/lib/server.js
@@ -35,8 +35,10 @@ function sendResource(reply, resource) {
 }
 
 /**
- * Fastify plugin for serving a styled map package. User `lazy: true` to defer
- * opening the file until the first request.
+ * Fastify plugin for serving a styled map package.
+ *
+ * If you provide a `Reader` (or `ReaderWatch`) instance via the `reader` opt,
+ * you must manually close the instance yourself.
  *
  * @type {FastifyPluginCallback<PluginOptions>}
  */