W3Booster SDK 2.0.0
First app
Guides
Examples
Preparing search index...
index
W3BoosterEventEmitter
Interface W3BoosterEventEmitter<TSettings, TOverlayExtensions>
interface
W3BoosterEventEmitter
<
TSettings
extends
object
=
JsonObject
,
TOverlayExtensions
extends
object
=
object
,
>
{
off
<
K
extends
keyof
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
>
(
type
:
K
,
listener
:
(
data
:
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
[
K
]
,
)
=>
void
,
)
:
void
;
off
(
type
:
string
,
listener
:
(
data
:
unknown
)
=>
void
)
:
void
;
on
<
K
extends
keyof
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
>
(
type
:
K
,
listener
:
(
data
:
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
[
K
]
,
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
;
on
(
type
:
"*"
,
listener
:
(
event
:
W3BoosterEvent
<
TSettings
,
TOverlayExtensions
>
,
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
;
once
<
K
extends
keyof
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
>
(
type
:
K
,
listener
:
(
data
:
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
[
K
]
,
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
;
once
(
type
:
"*"
,
listener
:
(
event
:
W3BoosterEvent
<
TSettings
,
TOverlayExtensions
>
,
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
;
onceUnknown
(
type
:
string
,
listener
:
(
data
:
unknown
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
;
onUnknown
(
type
:
string
,
listener
:
(
data
:
unknown
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
;
}
Type Parameters
TSettings
extends
object
=
JsonObject
TOverlayExtensions
extends
object
=
object
Index
Methods
off
on
once
once
Unknown
on
Unknown
Methods
off
off
<
K
extends
keyof
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
>
(
type
:
K
,
listener
:
(
data
:
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
[
K
]
,
)
=>
void
,
)
:
void
Type Parameters
K
extends
keyof
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
Parameters
type
:
K
listener
:
(
data
:
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
[
K
]
)
=>
void
Returns
void
off
(
type
:
string
,
listener
:
(
data
:
unknown
)
=>
void
)
:
void
Parameters
type
:
string
listener
:
(
data
:
unknown
)
=>
void
Returns
void
on
on
<
K
extends
keyof
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
>
(
type
:
K
,
listener
:
(
data
:
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
[
K
]
,
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
Type Parameters
K
extends
keyof
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
Parameters
type
:
K
listener
:
(
data
:
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
[
K
]
,
)
=>
void
|
Promise
<
void
>
Optional
options
:
SubscriptionOptions
Returns
()
=>
void
on
(
type
:
"*"
,
listener
:
(
event
:
W3BoosterEvent
<
TSettings
,
TOverlayExtensions
>
,
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
Parameters
type
:
"*"
listener
:
(
event
:
W3BoosterEvent
<
TSettings
,
TOverlayExtensions
>
)
=>
void
|
Promise
<
void
>
Optional
options
:
SubscriptionOptions
Returns
()
=>
void
once
once
<
K
extends
keyof
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
>
(
type
:
K
,
listener
:
(
data
:
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
[
K
]
,
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
Type Parameters
K
extends
keyof
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
Parameters
type
:
K
listener
:
(
data
:
W3BoosterEventMap
<
TSettings
,
TOverlayExtensions
>
[
K
]
,
)
=>
void
|
Promise
<
void
>
Optional
options
:
SubscriptionOptions
Returns
()
=>
void
once
(
type
:
"*"
,
listener
:
(
event
:
W3BoosterEvent
<
TSettings
,
TOverlayExtensions
>
,
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
Parameters
type
:
"*"
listener
:
(
event
:
W3BoosterEvent
<
TSettings
,
TOverlayExtensions
>
)
=>
void
|
Promise
<
void
>
Optional
options
:
SubscriptionOptions
Returns
()
=>
void
once
Unknown
onceUnknown
(
type
:
string
,
listener
:
(
data
:
unknown
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
Parameters
type
:
string
listener
:
(
data
:
unknown
)
=>
void
|
Promise
<
void
>
Optional
options
:
SubscriptionOptions
Returns
()
=>
void
on
Unknown
onUnknown
(
type
:
string
,
listener
:
(
data
:
unknown
)
=>
void
|
Promise
<
void
>
,
options
?:
SubscriptionOptions
,
)
:
()
=>
void
Parameters
type
:
string
listener
:
(
data
:
unknown
)
=>
void
|
Promise
<
void
>
Optional
options
:
SubscriptionOptions
Returns
()
=>
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
off
on
once
once
Unknown
on
Unknown
First app
Guides
Examples
W3Booster SDK 2.0.0
Loading...