Module: window
Functions
redirect
▸ redirect(messageOptions): Promise<void>
Parameters
| Name | Type |
|---|---|
messageOptions | MessageDataType<"windowRedirect"> |
Returns
Promise<void>
Defined in
src/channel.ts:462
routerPush
▸ routerPush(messageOptions): Promise<void>
Parameters
| Name | Type |
|---|---|
messageOptions | MessageDataType<"windowRouterPush"> |
Returns
Promise<void>
Defined in
src/channel.ts:462
reload
▸ reload(messageOptions?): Promise<void>
Factory method which creates a sender so that the type doesn't need to be defined and can be hidden. Also this allows to use a send method without a required second argument if the default options are defined.
Parameters
| Name | Type |
|---|---|
messageOptions? | MessageDataType<"windowReload"> |
Returns
Promise<void>
Defined in
src/channel.ts:452
Type Aliases
windowRedirect
Ƭ windowRedirect: Object
Redirect to another URL
Type declaration
| Name | Type | Description |
|---|---|---|
responseType | void | - |
url | string | The URL for the redirection |
newTab? | boolean | If this is activated then the link will be opened in a new tab |
Defined in
src/window/index.ts:10
windowRouterPush
Ƭ windowRouterPush: Object
Push to an existing route
Type declaration
| Name | Type |
|---|---|
responseType | void |
name? | string |
path? | string |
params? | Record<string, string> |
replace? | boolean |
Defined in
src/window/index.ts:25
windowReload
Ƭ windowReload: Object
Reload the current window
Type declaration
| Name | Type |
|---|---|
responseType | void |
Defined in
src/window/index.ts:36