Skip to content

Commit

Permalink
Changed docs to address PR comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Tony Wieser committed Jun 7, 2019
1 parent ca4a0cf commit 480699d
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions src/middleware/MiddlewareControl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,13 @@ export class MiddlewareControl {

/**
* @public
* To get the middleware option using the class name of the option
* @param {string} name - The class name of the strongly typed option class
* To get the middleware option using the class of the option
* @param {Function} fn - The class of the strongly typed option class
* @returns The middleware option
* @example
* // if you wanted to return the middleware option associated with this class (MiddlewareControl)
* // call this function like this:
* getMiddlewareOptions(MiddlewareControl)
*/
// tslint:disable-next-line:ban-types
public getMiddlewareOptions(fn: Function): MiddlewareOptions {
Expand All @@ -52,8 +56,8 @@ export class MiddlewareControl {

/**
* @public
* To set the middleware options using the class name of the option
* @param {string} name - The class name of the strongly typed option class
* To set the middleware options using the class of the option
* @param {Function} fn - The class of the strongly typed option class
* @param {MiddlewareOptions} option - The strongly typed middleware option
* @returns nothing
*/
Expand Down

0 comments on commit 480699d

Please sign in to comment.