API Reference
    Preparing search index...

    Class GetOptions

    Options for the get method.

    It merges the default options with the provided options.

    Hierarchy (View Summary)

    Implements

    Index
    constructor
    forceFetch maxAge sdkOptions? throwOnMissing transform?
    forceFetch: boolean = false

    Force fetch the value from the parameter store, ignoring the cache.

    maxAge: number

    Maximum age of the value in the cache, in seconds.

    sdkOptions?: unknown

    Options to pass to the underlying SDK.

    throwOnMissing: boolean = false

    Whether to throw a ParameterNotFoundError | ParameterNotFoundError when the parameter is not found in the store. When set to true, the return type is narrowed to exclude undefined. Defaults to false.

    transform?: TransformOptions

    Transform to be applied, can be json or binary.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties