@aws-lambda-powertools/parameters/lib/esm/types/BaseProvider.d.ts

The parameters package for the Powertools for AWS Lambda (TypeScript) library

import type { Transform } from '../constants.js';
/**
 * Options for the BaseProvider class constructor.
 */
type BaseProviderConstructorOptions = {
    /**
     * AWS SDK v3 client instance to use for operations.
     */
    awsSdkV3Client?: unknown;
    /**
     * Optional configuration to pass during client initialization to customize AWS SDK v3 clients.
     */
    clientConfig?: unknown;
    /**
     * AWS SDK v3 client prototype.
     *
     * If the `awsSdkV3Client` is not provided, this will be used to create a new client.
     */
    awsSdkV3ClientPrototype?: new (config?: unknown) => unknown;
};
/**
 * Type for the transform option.
 */
type TransformOptions = (typeof Transform)[keyof typeof Transform];
/**
 * Options for the `get` method.
 *
 * @property {number} maxAge - Maximum age of the value in the cache, in seconds. Will be applied after the first API call.
 * @property {boolean} forceFetch - Force fetch the value from the parameter store, ignoring the cache.
 * @property {unknown} sdkOptions - Options to pass to the underlying SDK.
 * @property {TransformOptions} transform - Transform to be applied, can be 'json', 'binary', or 'auto'.
 */
interface GetOptionsInterface {
    /**
     * Maximum age of the value in the cache, in seconds.
     */
    maxAge?: number;
    /**
     * Force fetch the value from the parameter store, ignoring the cache.
     */
    forceFetch?: boolean;
    /**
     * Options to pass to the underlying SDK.
     */
    sdkOptions?: unknown;
    /**
     * Transform to be applied, can be `json` or `binary`.
     */
    transform?: Omit<TransformOptions, 'auto'>;
}
/**
 * Options for the `getMultiple` method.
 *
 * @property {number} maxAge - Maximum age of the value in the cache, in seconds. Will be applied after the first API call.
 * @property {boolean} forceFetch - Force fetch the value from the parameter store, ignoring the cache.
 * @property {unknown} sdkOptions - Options to pass to the underlying SDK.
 * @property {TransformOptions} transform - Transform to be applied, can be 'json', 'binary', or 'auto'.
 * @property {boolean} throwOnTransformError - Whether to throw an error if a value cannot be transformed.
 */
interface GetMultipleOptionsInterface extends GetOptionsInterface {
    /**
     * Transform to be applied, can be `json`, `binary`, or `auto`.
     */
    transform?: TransformOptions;
    /**
     * Whether to throw an error if a value cannot be transformed.
     */
    throwOnTransformError?: boolean;
}
/**
 * Interface for a value that can expire.
 */
interface ExpirableValueInterface {
    /**
     * Value of the parameter.
     */
    value: unknown;
    /**
     * Expiration timestamp of the value.
     */
    ttl: number;
}
/**
 * Interface for a parameter store provider.
 */
interface BaseProviderInterface {
    get(name: string, options?: GetOptionsInterface): Promise<unknown>;
    getMultiple(path: string, options?: GetMultipleOptionsInterface): Promise<unknown>;
    clearCache?(): void;
}
export type { BaseProviderConstructorOptions, GetOptionsInterface, GetMultipleOptionsInterface, BaseProviderInterface, ExpirableValueInterface, TransformOptions, };
//# sourceMappingURL=BaseProvider.d.ts.map