UNPKG

1.79 kBTypeScriptView Raw
1/**
2 * -------------------------------------------------------------------------------------------
3 * Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License.
4 * See License in the project root for license information.
5 * -------------------------------------------------------------------------------------------
6 */
7/**
8 * @module MiddlewareControl
9 */
10import { MiddlewareOptions } from "./options/IMiddlewareOptions";
11/**
12 * @class
13 * Class representing MiddlewareControl
14 */
15export declare class MiddlewareControl {
16 /**
17 * @private
18 * A member holding map of MiddlewareOptions
19 */
20 private middlewareOptions;
21 /**
22 * @public
23 * @constructor
24 * Creates an instance of MiddlewareControl
25 * @param {MiddlewareOptions[]} [middlewareOptions = []] - The array of middlewareOptions
26 * @returns The instance of MiddlewareControl
27 */
28 constructor(middlewareOptions?: MiddlewareOptions[]);
29 /**
30 * @public
31 * To get the middleware option using the class of the option
32 * @param {Function} fn - The class of the strongly typed option class
33 * @returns The middleware option
34 * @example
35 * // if you wanted to return the middleware option associated with this class (MiddlewareControl)
36 * // call this function like this:
37 * getMiddlewareOptions(MiddlewareControl)
38 */
39 getMiddlewareOptions(fn: Function): MiddlewareOptions;
40 /**
41 * @public
42 * To set the middleware options using the class of the option
43 * @param {Function} fn - The class of the strongly typed option class
44 * @param {MiddlewareOptions} option - The strongly typed middleware option
45 * @returns nothing
46 */
47 setMiddlewareOptions(fn: Function, option: MiddlewareOptions): void;
48}