@gooddata/gooddata-js/lib/config.d.ts

GoodData JavaScript SDK

export declare function sanitizeDomain(domain: string | null): string | undefined;
/**
 * Returns sanitized config
 *
 * @method sanitizeConfig
 * @return {object|undefined} config with sanitized domain
 */
export declare function sanitizeConfig(config: any): any;
export interface IOriginPackage {
    name: string;
    version: string;
}
export interface IConfigStorage {
    domain?: string;
    originPackage?: IOriginPackage;
}
/**
 * Config factory
 *
 * @param {object|null} configStorage config object
 * @method createModule
 * @return SDK config module
 */
export declare class ConfigModule {
    private configStorage;
    constructor(configStorage: IConfigStorage);
    /**
     * Sets custom domain. Parameter is url which has always to be https://
     * (if you don't provide it, we will do it for you).
     *
     * RegExp inspired taken from
     * https://github.com/jarib/google-closure-library/blob/master/closure/goog/string/linkify.js
     * @param {String|null} domain valid domain starting with https:// or null for removing
     * @method setCustomDomain
     */
    setCustomDomain(domain: string): void;
    /**
     * Returns current domain
     *
     * @method getCustomDomain
     */
    getCustomDomain(): string | undefined;
    /**
     * Sets JS package and version info
     *
     * @method setJsPackage
     * @param {String} name package name
     * @param {String} version package version (semver)
     * @private
     */
    setJsPackage(name: string, version: string): void;
    /**
     * Returns JS package and version info
     *
     * @method getJsPackage
     * @return {object} with 'name' and 'version' properties
     * @private
     */
    getJsPackage(): IOriginPackage | undefined;
    setRequestHeader(key: string, value: string): void;
    getRequestHeader(key: string): any;
}