Interface AstraLibArgs

interface AstraLibArgs {
    batchSize?: number;
    collection: string;
    collectionOptions?: CreateCollectionOptions<any>;
    contentKey?: string;
    endpoint: string;
    idKey?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    namespace?: string;
    onFailedAttempt?: FailedAttemptHandler;
    skipCollectionProvisioning?: boolean;
    token: string;
}

Hierarchy

  • AsyncCallerParams
    • AstraLibArgs

Properties

batchSize? collection collectionOptions? contentKey? endpoint idKey? maxConcurrency? maxRetries? namespace? onFailedAttempt? skipCollectionProvisioning? token

Properties

OptionalbatchSize

batchSize?: number

collection

collection: string

OptionalcollectionOptions

collectionOptions?: CreateCollectionOptions<any>

OptionalcontentKey

contentKey?: string

endpoint

endpoint: string

OptionalidKey

idKey?: string

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

Optionalnamespace

namespace?: string

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

OptionalskipCollectionProvisioning

skipCollectionProvisioning?: boolean

token

token: string

Settings

Member Visibility

On This Page

Properties