Detail explicitly middleware's options in README

koajs · May 21, 2020 · fa27b12 · fa27b12
1 parent d7f9678
commit fa27b12
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -84,11 +84,20 @@ should match the following interface:
  * Your custom token resolver
  * @this The ctx object passed to the middleware
  *
- * @param  {object}      opts The middleware's options
+ * @param  {Object}      opts The middleware's options
  * @return {String|null}      The resolved token or null if not found
  */
 ```
 
+opts, the middleware's options:
+
+* getToken
+* secret
+* key
+* isRevoked
+* passthrough
+* debug
+
 The resolution order for the token is the following. The first non-empty token resolved will be the one that is verified.
 
 * `opts.getToken` function.