Interface Config

Configuration interface.

interface Config {
    addCorsEnabledServer(server: CorsServerDescriptor): void;
    addPostProcessor(processor: PostProcessor): void;
    addPreProcessor(processor: PreProcessor): void;
    addProxyRule(rule: ProxyRuleDescriptor): void;
    addTrustedServer(server: TrustedServerDescriptor): void;
    buildProvider(): ExtendedDojoProvider;
    get<Name>(name: Name): ConfigProperties[Name];
    removeCorsEnabledServer(server: CorsServerDescriptor): void;
    removePostProcessor(processor: PostProcessor): void;
    removePreProcessor(processor: PreProcessor): void;
    removeProxyRule(rule: ProxyRuleDescriptor): void;
    removeTrustedServer(server: TrustedServerDescriptor): void;
    reset(): void;
    set<Name>(name: Name, value: ConfigProperties[Name]): void;
}

Index

Methods

addCorsEnabledServer addPostProcessor addPreProcessor addProxyRule addTrustedServer buildProvider get removeCorsEnabledServer removePostProcessor removePreProcessor removeProxyRule removeTrustedServer reset set

Methods

addCorsEnabledServer

addCorsEnabledServer(server): void
Parameters
- server: CorsServerDescriptor
Returns void
Deprecated
- Defined in api.ts:190

addPostProcessor

addPostProcessor(processor): void
Register a post-processor
Parameters
- processor: PostProcessor
  a post-processor
Returns void
- Defined in api.ts:210

addPreProcessor

addPreProcessor(processor): void
Register a pre-processor
Parameters
- processor: PreProcessor
  a pre-processor
Returns void
- Defined in api.ts:199

addProxyRule

addProxyRule(rule): void
Register a proxy rule. If the rule matches, the request will be routed over a proxy.
Parameters
- rule: ProxyRuleDescriptor
  a proxy rule.
Returns void
- Defined in api.ts:171

addTrustedServer

addTrustedServer(server): void
Register a trusted server, for which 'withCredentials' will be activated.
Parameters
- server: TrustedServerDescriptor
  a trusted server.
Returns void
- Defined in api.ts:182

buildProvider

buildProvider(): ExtendedDojoProvider
Only for internal usage.

Returns ExtendedDojoProvider
- Defined in api.ts:150

get

get<Name>(name): ConfigProperties[Name]
Get a config option.
Type Parameters
- Name extends keyof ConfigProperties
Parameters
- name: Name
  name of the option.
Returns ConfigProperties[Name]
- Defined in api.ts:164

removeCorsEnabledServer

removeCorsEnabledServer(server): void
Parameters
- server: CorsServerDescriptor
Returns void
Deprecated
- Defined in api.ts:193

removePostProcessor

removePostProcessor(processor): void
Unregister a post-processor
Parameters
- processor: PostProcessor
  a post-processor
Returns void
- Defined in api.ts:215

removePreProcessor

removePreProcessor(processor): void
Unregister a pre-processor
Parameters
- processor: PreProcessor
  a pre-processor
Returns void
- Defined in api.ts:204

removeProxyRule

removeProxyRule(rule): void
Removes a proxy rule.
Parameters
- rule: ProxyRuleDescriptor
  the rule to remove.
Returns void
- Defined in api.ts:176

removeTrustedServer

removeTrustedServer(server): void
Removes a trusted servers.
Parameters
- server: TrustedServerDescriptor
  a trusted server.
Returns void
- Defined in api.ts:187

reset

reset(): void
Reset the configuration to it's defaults. Only intended for tests.

Returns void
- Defined in api.ts:221

set

set<Name>(name, value): void
Set a config option.
Type Parameters
- Name extends keyof ConfigProperties
Parameters
- name: Name
  name of the option.
- value: ConfigProperties[Name]
  value of the option.
Returns void
- Defined in api.ts:157