package.dist.src.auth-client-props.d.ts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation

Client SDK for Momento services

The newest version!

import { CredentialProvider } from '.';
import { AuthClientConfiguration } from './config/auth-client-configuration';
export interface AuthClientProps {
    /**
     * controls how the client will get authentication information for connecting to the Momento service
     */
    credentialProvider?: CredentialProvider;
    /**
     * Controls the configuration settings for the auth client, such as logging configuration.
     */
    configuration?: AuthClientConfiguration;
    /**
     * Configures whether the client should return a Momento Error object or throw an exception when an
     * error occurs. By default, this is set to false, and the client will return a Momento Error object on errors. Set it
     * to true if you prefer for exceptions to be thrown.
     */
    throwOnErrors?: boolean;
}