Skip to main content

Module: location

Functions​

is​

▸ is(location): boolean

Parameters​

NameType
locationstring

Returns​

boolean

Defined in​

src/location/index.ts:5

get​

▸ get(): string

Returns​

string

Defined in​

src/location/index.ts:9

isIframe​

▸ isIframe(): boolean

Returns​

boolean

Defined in​

src/location/index.ts:13

updateHeight​

▸ updateHeight(height?): Promise<null | void>

Parameters​

NameType
height?number

Returns​

Promise<null | void>

Defined in​

src/location/index.ts:17

startAutoResizer​

▸ startAutoResizer(): void

Returns​

void

Defined in​

src/location/index.ts:36

stopAutoResizer​

▸ stopAutoResizer(): void

Returns​

void

Defined in​

src/location/index.ts:46

updateUrl​

▸ updateUrl(url): Promise<null | void>

Parameters​

NameType
urlURL

Returns​

Promise<null | void>

Defined in​

src/location/index.ts:53

startAutoUrlUpdater​

▸ startAutoUrlUpdater(): void

Returns​

void

Defined in​

src/location/index.ts:64

stopAutoUrlUpdater​

▸ stopAutoUrlUpdater(): void

Returns​

void

Defined in​

src/location/index.ts:81

Variables​

MAIN_HIDDEN​

• Const MAIN_HIDDEN: "sw-main-hidden"

Defined in​

src/location/index.ts:87

Type Aliases​

locationUpdateHeight​

Ƭ locationUpdateHeight: Object

Type declaration​

NameTypeDescription
responseTypevoid-
heightnumberThe height of the iFrame
locationIdstring | nullThe locationID of the current element

Defined in​

src/location/index.ts:89

locationUpdateUrl​

Ƭ locationUpdateUrl: Object

Type declaration​

NameTypeDescription
responseTypevoid-
hashstringThe hash of the url Example ts #/sw/dashboard
pathnamestringThe pathname of the url Example ts /
searchParams[string, string][]The searchParams of the url Example ts [ ['foo', 'bar'], ['baz', 'qux'], ]
locationIdstring | nullThe locationID of the current element

Defined in​

src/location/index.ts:103