File tree Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Original file line number Diff line number Diff line change @@ -41,9 +41,13 @@ export class MiddlewareControl {
41
41
42
42
/**
43
43
* @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
46
46
* @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)
47
51
*/
48
52
// tslint:disable-next-line:ban-types
49
53
public getMiddlewareOptions ( fn : Function ) : MiddlewareOptions {
@@ -52,8 +56,8 @@ export class MiddlewareControl {
52
56
53
57
/**
54
58
* @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
57
61
* @param {MiddlewareOptions } option - The strongly typed middleware option
58
62
* @returns nothing
59
63
*/
You can’t perform that action at this time.
0 commit comments