W3Booster SDK 2.0.0
First app
Guides
Examples
Preparing search index...
app
DefinedApplication
Interface DefinedApplication<TSettings, TScopes>
interface
DefinedApplication
<
TSettings
extends
object
,
TScopes
extends
readonly
Scope
[]
,
>
{
clientId
:
string
;
revision
:
string
;
scopes
:
TScopes
;
settingsDefaults
:
DeepReadonly
<
JsonCompatible
<
TSettings
>
>
;
createClient
<
TOverlayExtensions
extends
object
=
object
>
(
...
args
:
ApplicationConnectArguments
<
TSettings
,
TScopes
,
TOverlayExtensions
,
>
,
)
:
W3BoosterClient
<
DeepPartial
<
TSettings
>
,
TOverlayExtensions
>
;
createRuntime
<
TOverlayExtensions
extends
object
=
object
>
(
...
args
:
ApplicationConnectArguments
<
TSettings
,
TScopes
,
TOverlayExtensions
,
>
,
)
:
ApplicationRuntime
<
TSettings
,
TOverlayExtensions
>
;
open
<
TOverlayExtensions
extends
object
=
object
>
(
...
args
:
ApplicationConnectArguments
<
TSettings
,
TScopes
,
TOverlayExtensions
,
>
,
)
:
Promise
<
W3BoosterClient
<
DeepPartial
<
TSettings
>
,
TOverlayExtensions
>
>
;
resolveSettings
(
settings
?:
DeepPartial
<
TSettings
>
)
:
DeepReadonly
<
TSettings
>
;
settingsFor
(
state
:
|
Pick
<
MatchState
<
DeepPartial
<
TSettings
>
,
object
>
,
"application"
>
|
null
|
undefined
,
)
:
DeepReadonly
<
TSettings
>
;
start
<
TOverlayExtensions
extends
object
=
object
>
(
...
args
:
TOverlayExtensions
extends
OverlayExtensionsInput
<
TOverlayExtensions
,
>
?
[
options
?:
ApplicationConnectOptions
<
TSettings
,
TScopes
,
TOverlayExtensions
,
>
,
startup
?:
StartupOptions
,
]
:
[
options
:
never
,
startup
?:
undefined
]
,
)
:
Promise
<
W3BoosterClient
<
DeepPartial
<
TSettings
>
,
TOverlayExtensions
>
>
;
}
Type Parameters
TSettings
extends
object
TScopes
extends
readonly
Scope
[]
Hierarchy (
View Summary
)
ApplicationDefinition
<
TSettings
,
TScopes
>
DefinedApplication
Index
Properties
client
Id
revision
scopes
settings
Defaults
Methods
create
Client
create
Runtime
open
resolve
Settings
settings
For
start
Properties
Readonly
client
Id
clientId
:
string
Readonly
revision
revision
:
string
Readonly
scopes
scopes
:
TScopes
Readonly
settings
Defaults
settingsDefaults
:
DeepReadonly
<
JsonCompatible
<
TSettings
>
>
Methods
create
Client
createClient
<
TOverlayExtensions
extends
object
=
object
>
(
...
args
:
ApplicationConnectArguments
<
TSettings
,
TScopes
,
TOverlayExtensions
,
>
,
)
:
W3BoosterClient
<
DeepPartial
<
TSettings
>
,
TOverlayExtensions
>
Type Parameters
TOverlayExtensions
extends
object
=
object
Parameters
...
args
:
ApplicationConnectArguments
<
TSettings
,
TScopes
,
TOverlayExtensions
>
Returns
W3BoosterClient
<
DeepPartial
<
TSettings
>
,
TOverlayExtensions
>
create
Runtime
createRuntime
<
TOverlayExtensions
extends
object
=
object
>
(
...
args
:
ApplicationConnectArguments
<
TSettings
,
TScopes
,
TOverlayExtensions
,
>
,
)
:
ApplicationRuntime
<
TSettings
,
TOverlayExtensions
>
Type Parameters
TOverlayExtensions
extends
object
=
object
Parameters
...
args
:
ApplicationConnectArguments
<
TSettings
,
TScopes
,
TOverlayExtensions
>
Returns
ApplicationRuntime
<
TSettings
,
TOverlayExtensions
>
open
open
<
TOverlayExtensions
extends
object
=
object
>
(
...
args
:
ApplicationConnectArguments
<
TSettings
,
TScopes
,
TOverlayExtensions
,
>
,
)
:
Promise
<
W3BoosterClient
<
DeepPartial
<
TSettings
>
,
TOverlayExtensions
>
>
Type Parameters
TOverlayExtensions
extends
object
=
object
Parameters
...
args
:
ApplicationConnectArguments
<
TSettings
,
TScopes
,
TOverlayExtensions
>
Returns
Promise
<
W3BoosterClient
<
DeepPartial
<
TSettings
>
,
TOverlayExtensions
>
>
resolve
Settings
resolveSettings
(
settings
?:
DeepPartial
<
TSettings
>
)
:
DeepReadonly
<
TSettings
>
Parameters
Optional
settings
:
DeepPartial
<
TSettings
>
Returns
DeepReadonly
<
TSettings
>
settings
For
settingsFor
(
state
:
|
Pick
<
MatchState
<
DeepPartial
<
TSettings
>
,
object
>
,
"application"
>
|
null
|
undefined
,
)
:
DeepReadonly
<
TSettings
>
Parameters
state
:
|
Pick
<
MatchState
<
DeepPartial
<
TSettings
>
,
object
>
,
"application"
>
|
null
|
undefined
Returns
DeepReadonly
<
TSettings
>
start
start
<
TOverlayExtensions
extends
object
=
object
>
(
...
args
:
TOverlayExtensions
extends
OverlayExtensionsInput
<
TOverlayExtensions
,
>
?
[
options
?:
ApplicationConnectOptions
<
TSettings
,
TScopes
,
TOverlayExtensions
,
>
,
startup
?:
StartupOptions
,
]
:
[
options
:
never
,
startup
?:
undefined
]
,
)
:
Promise
<
W3BoosterClient
<
DeepPartial
<
TSettings
>
,
TOverlayExtensions
>
>
Type Parameters
TOverlayExtensions
extends
object
=
object
Parameters
...
args
:
TOverlayExtensions
extends
OverlayExtensionsInput
<
TOverlayExtensions
>
?
[
options
?:
ApplicationConnectOptions
<
TSettings
,
TScopes
,
TOverlayExtensions
,
>
,
startup
?:
StartupOptions
,
]
:
[
options
:
never
,
startup
?:
undefined
]
Returns
Promise
<
W3BoosterClient
<
DeepPartial
<
TSettings
>
,
TOverlayExtensions
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
client
Id
revision
scopes
settings
Defaults
Methods
create
Client
create
Runtime
open
resolve
Settings
settings
For
start
First app
Guides
Examples
W3Booster SDK 2.0.0
Loading...