@aws-sdk/util-defaults-mode-browser

An internal package

Usage

You probably shouldn't, at least directly.

Index

References

Interfaces

Variables

DEFAULTS_MODE_OPTIONS

Functions

References

ResolveDefaultsModeConfigOptions

Re-exports ResolveDefaultsModeConfigOptions

resolveDefaultsModeConfig

Re-exports resolveDefaultsModeConfig

Variables

Const DEFAULTS_MODE_OPTIONS

DEFAULTS_MODE_OPTIONS: string[] = ["in-region", "cross-region", "mobile", "standard", "legacy"]

Functions

Const isMobileBrowser

isMobileBrowser(): boolean

- Defined in packages/util-defaults-mode-browser/src/resolveDefaultsModeConfig.ts:46
Returns boolean

Const resolveDefaultsModeConfig

resolveDefaultsModeConfig(__namedParameters?: { defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode> }): Provider<ResolvedDefaultsMode>

- Defined in packages/util-defaults-mode-browser/src/resolveDefaultsModeConfig.ts:23
Validate the defaultsMode configuration. If the value is set to "auto", it resolves the value to "mobile" if the app is running in a mobile browser, otherwise it resolves to "standard".

default

"legacy"

internal

Parameters
- Default value __namedParameters: { defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode> } = {}
  - defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode>
Returns Provider<ResolvedDefaultsMode>

Const resolveDefaultsModeConfig

resolveDefaultsModeConfig(__namedParameters?: { defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode> }): Provider<ResolvedDefaultsMode>

- Defined in packages/util-defaults-mode-browser/src/resolveDefaultsModeConfig.native.ts:21
Validate the defaultsMode configuration. If the value is set to "auto", it resolves the value to "mobile".

default

"legacy"

internal

Parameters
- Default value __namedParameters: { defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode> } = {}
  - defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode>
Returns Provider<ResolvedDefaultsMode>

@aws-sdk/util-defaults-mode-browser

Usage

Index

References

Interfaces

Variables

Functions

References

ResolveDefaultsModeConfigOptions

resolveDefaultsModeConfig

Variables

Const DEFAULTS_MODE_OPTIONS

Functions

Const isMobileBrowser

Returns boolean

Const resolveDefaultsModeConfig

Parameters

Default value __namedParameters: { defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode> } = {}

defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode>

Returns Provider<ResolvedDefaultsMode>

Const resolveDefaultsModeConfig

Parameters

Default value __namedParameters: { defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode> } = {}

defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode>

Returns Provider<ResolvedDefaultsMode>