couchbase/dist/configProfile.js

The official Couchbase Node.js Client Library.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.knownProfiles = exports.ConfigProfiles = exports.WanDevelopmentProfile = void 0;
/**
 * The WAN Development profile sets various timeout options that are useful
 * when working in a WAN environment.
 *
 * Volatile: This API is subject to change at any time.
 */
class WanDevelopmentProfile {
    /**
     * Applies the ConfigProfile options to the provided ConnectOptions.
     *
     * Volatile: This API is subject to change at any time.
     *
     * @param options The Connect options the ConfigProfile should be applied toward.
     */
    apply(options) {
        // the profile should override previously set values
        options.timeouts = {
            ...options.timeouts,
            ...{
                kvTimeout: 20000,
                kvDurableTimeout: 20000,
                analyticsTimeout: 120000,
                managementTimeout: 120000,
                queryTimeout: 120000,
                searchTimeout: 120000,
                viewTimeout: 120000,
                bootstrapTimeout: 120000,
                connectTimeout: 20000,
                resolveTimeout: 20000,
            },
        };
        options.dnsConfig = { ...options.dnsConfig, ...{ dnsSrvTimeout: 20000 } };
    }
}
exports.WanDevelopmentProfile = WanDevelopmentProfile;
/**
 * The ConfigProfiles class keeps track of registered/known Configuration Profiles.
 *
 * Volatile: This API is subject to change at any time.
 */
class ConfigProfiles {
    constructor() {
        this._profiles = {};
        this.registerProfile('wanDevelopment', new WanDevelopmentProfile());
    }
    /**
     * Applies the specified registered ConfigProfile to the provided ConnectOptions.
     *
     * Volatile: This API is subject to change at any time.
     *
     *  @param profileName The name of the ConfigProfile to apply.
     *  @param options The Connect options the ConfigProfile should be applied toward.
     */
    applyProfile(profileName, options) {
        if (!(profileName in this._profiles)) {
            throw new Error(`${profileName} is not a registered profile.`);
        }
        this._profiles[profileName].apply(options);
    }
    /**
     * Registers a ConfigProfile under the specified name.
     *
     * Volatile: This API is subject to change at any time.
     *
     *  @param profileName The name the ConfigProfile should be registered under.
     *  @param profile The ConfigProfile to register.
     */
    registerProfile(profileName, profile) {
        this._profiles[profileName] = profile;
    }
    /**
     * Unregisters the specified ConfigProfile.
     *
     * Volatile: This API is subject to change at any time.
     *
     *  @param profileName The name of the ConfigProfile to unregister.
     */
    unregisterProfile(profileName) {
        delete this._profiles[profileName];
    }
}
exports.ConfigProfiles = ConfigProfiles;
exports.knownProfiles = new ConfigProfiles();