Skip to content

Commit 480699d

Browse files
author
Tony Wieser
committed
Changed docs to address PR comments.
1 parent ca4a0cf commit 480699d

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/middleware/MiddlewareControl.ts

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,13 @@ export class MiddlewareControl {
4141

4242
/**
4343
* @public
44-
* To get the middleware option using the class name of the option
45-
* @param {string} name - The class name of the strongly typed option class
44+
* To get the middleware option using the class of the option
45+
* @param {Function} fn - The class of the strongly typed option class
4646
* @returns The middleware option
47+
* @example
48+
* // if you wanted to return the middleware option associated with this class (MiddlewareControl)
49+
* // call this function like this:
50+
* getMiddlewareOptions(MiddlewareControl)
4751
*/
4852
// tslint:disable-next-line:ban-types
4953
public getMiddlewareOptions(fn: Function): MiddlewareOptions {
@@ -52,8 +56,8 @@ export class MiddlewareControl {
5256

5357
/**
5458
* @public
55-
* To set the middleware options using the class name of the option
56-
* @param {string} name - The class name of the strongly typed option class
59+
* To set the middleware options using the class of the option
60+
* @param {Function} fn - The class of the strongly typed option class
5761
* @param {MiddlewareOptions} option - The strongly typed middleware option
5862
* @returns nothing
5963
*/

0 commit comments

Comments
 (0)