IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Interface ClientDefaults

    interface ClientDefaults {
        requestHandler?: HttpHandlerUserInput;
        sha256?: ChecksumConstructor | HashConstructor;
        urlParser?: UrlParser;
        bodyLengthChecker?: BodyLengthCalculator;
        streamCollector?: StreamCollector;
        base64Decoder?: Decoder;
        base64Encoder?: Encoder;
        utf8Decoder?: Decoder;
        utf8Encoder?: Encoder;
        runtime?: string;
        disableHostPrefix?: boolean;
        serviceId?: string;
        useDualstackEndpoint?: boolean | Provider<boolean>;
        useFipsEndpoint?: boolean | Provider<boolean>;
        region?: string | Provider<string>;
        profile?: string;
        defaultUserAgentProvider?: Provider<UserAgent>;
        streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>;
        md5?: ChecksumConstructor | HashConstructor;
        sha1?: ChecksumConstructor | HashConstructor;
        getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream<any>;
        credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
        maxAttempts?: number | Provider<number>;
        retryMode?: string | Provider<string>;
        logger?: Logger;
        extensions?: RuntimeExtension[];
        eventStreamSerdeProvider?: EventStreamSerdeProvider;
        defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
        signingEscapePath?: boolean;
        useArnRegion?: boolean | Provider<boolean | undefined>;
        sdkStreamMixin?: SdkStreamMixinInjector;
    }

    Hierarchy

    • Partial<__SmithyConfiguration<__HttpHandlerOptions>>
      • ClientDefaults
    Index

    Properties

    requestHandler?: HttpHandlerUserInput

    The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

    sha256?: ChecksumConstructor | HashConstructor

    A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.

    urlParser?: UrlParser

    The function that will be used to convert strings into HTTP endpoints.

    bodyLengthChecker?: BodyLengthCalculator

    A function that can calculate the length of a request body.

    streamCollector?: StreamCollector

    A function that converts a stream into an array of bytes.

    base64Decoder?: Decoder

    The function that will be used to convert a base64-encoded string to a byte array.

    base64Encoder?: Encoder

    The function that will be used to convert binary data to a base64-encoded string.

    utf8Decoder?: Decoder

    The function that will be used to convert a UTF8-encoded string to a byte array.

    utf8Encoder?: Encoder

    The function that will be used to convert binary data to a UTF-8 encoded string.

    runtime?: string

    The runtime environment.

    disableHostPrefix?: boolean

    Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

    serviceId?: string

    Unique service identifier.

    useDualstackEndpoint?: boolean | Provider<boolean>

    Enables IPv6/IPv4 dualstack endpoint.

    useFipsEndpoint?: boolean | Provider<boolean>

    Enables FIPS compatible endpoints.

    region?: string | Provider<string>

    The AWS region to which this client will send requests

    profile?: string

    Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.

    When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.

    For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

    defaultUserAgentProvider?: Provider<UserAgent>

    The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header

    streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>

    A function that, given a hash constructor and a stream, calculates the hash of the streamed value.

    md5?: ChecksumConstructor | HashConstructor

    A constructor for a class implementing the __Checksum interface that computes MD5 hashes.

    sha1?: ChecksumConstructor | HashConstructor

    A constructor for a class implementing the __Checksum interface that computes SHA1 hashes.

    getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream<any>

    A function that returns Readable Stream which follows aws-chunked encoding stream.

    credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider

    Default credentials provider; Not available in browser runtime.

    maxAttempts?: number | Provider<number>

    Value for how many times a request will be made at most in case of retry.

    retryMode?: string | Provider<string>

    Specifies which retry algorithm to use.

    logger?: Logger

    Optional logger for logging debug/info/warn/error.

    extensions?: RuntimeExtension[]

    Optional extensions

    eventStreamSerdeProvider?: EventStreamSerdeProvider

    The function that provides necessary utilities for generating and parsing event stream

    defaultsMode?: DefaultsMode | Provider<DefaultsMode>

    The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

    signingEscapePath?: boolean

    Whether to escape request path when signing the request.

    useArnRegion?: boolean | Provider<boolean | undefined>

    Whether to override the request region with the region inferred from requested resource's ARN. Defaults to undefined.

    sdkStreamMixin?: SdkStreamMixinInjector

    The internal function that inject utilities to runtime-specific stream to help users consume the data