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 extends keyof ConfigProperties>(
        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 extends keyof ConfigProperties>(
        name: Name,
        value: ConfigProperties[Name],
    ): void;
}

Methods

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

Methods

addCorsEnabledServer

addPostProcessor

  • addPostProcessor(processor: PostProcessor): void

  • Register a post-processor

    Parameters

    Returns void

addPreProcessor

  • addPreProcessor(processor: PreProcessor): void

  • Register a pre-processor

    Parameters

    Returns void

addProxyRule

  • addProxyRule(rule: ProxyRuleDescriptor): void

  • Register a proxy rule. If the rule matches, the request will be routed over a proxy.

    Parameters

    Returns void

addTrustedServer

buildProvider

  • buildProvider(): ExtendedDojoProvider

  • Only for internal usage.

    Returns ExtendedDojoProvider

get

removeCorsEnabledServer

removePostProcessor

  • removePostProcessor(processor: PostProcessor): void

  • Unregister a post-processor

    Parameters

    Returns void

removePreProcessor

  • removePreProcessor(processor: PreProcessor): void

  • Unregister a pre-processor

    Parameters

    Returns void

removeProxyRule

removeTrustedServer

reset

  • reset(): void

  • Reset the configuration to it's defaults. Only intended for tests.

    Returns void

set

Settings

Member Visibility

On This Page

Methods