Type Alias ClientOptions

ClientOptions: {
    cacheConfiguration?: Partial<CacheConfiguration> & {
        enabled?: boolean;
    };
    logger?: AbstractLogger;
    requestTimeout?: number;
    useAccountCreationAPI?: boolean;
}

The options to instantiate a new CFTools client with. The client options can be used to configure the client with a custom logger and cache configuration.

Type declaration

  • OptionalcacheConfiguration?: Partial<CacheConfiguration> & {
        enabled?: boolean;
    }

    The cache configuration to use for the client. If not provided, the default cache configuration will be used. See defaultCacheConfiguration.

  • Optionallogger?: AbstractLogger

    The logger to use for the client. If not provided, a new logger will be created and used that only logs entries of level ERROR and higher.

  • OptionalrequestTimeout?: number

    The amount of time (in ms) that has to pass before requests are considered timed out, and aborted.

  • OptionaluseAccountCreationAPI?: boolean

    Should the Account Creation API be used? Explicit permission needs to be obtained from the CFTools team to use this API. When enabled, the client will create user accounts for identities that have never connected to cftools-enabled servers.

Settings

Member Visibility