Teleforge API Reference - v0.1.0
Preparing search index...
core/src
EventBus
Interface EventBus
interface
EventBus
{
emit
<
TType
extends
EventType
>
(
type
:
TType
,
payload
:
TeleforgeEventMap
[
TType
]
,
options
?:
EmitEventOptions
,
)
:
TeleforgeEvent
<
TType
>
;
emit
<
TType
extends
string
,
TPayload
>
(
event
:
TeleforgeEventInput
<
TType
,
TPayload
>
,
)
:
TeleforgeEvent
<
TType
,
TPayload
>
;
off
<
TType
extends
string
,
TPayload
=
EventPayload
<
TType
>
>
(
type
:
TType
,
handler
:
EventHandler
<
TPayload
,
TType
>
,
)
:
void
;
on
<
TType
extends
string
,
TPayload
=
EventPayload
<
TType
>
>
(
type
:
TType
,
handler
:
EventHandler
<
TPayload
,
TType
>
,
)
:
()
=>
void
;
once
<
TType
extends
string
,
TPayload
=
EventPayload
<
TType
>
>
(
type
:
TType
,
handler
:
EventHandler
<
TPayload
,
TType
>
,
)
:
()
=>
void
;
publishToBot
:
(
payload
:
unknown
)
=>
void
;
request
<
TReq
extends
EventType
,
TRes
extends
EventType
>
(
requestType
:
TReq
,
payload
:
TeleforgeEventMap
[
TReq
]
,
responseType
:
TRes
,
timeoutMs
?:
number
,
options
?:
EmitEventOptions
,
)
:
Promise
<
TeleforgeEventMap
[
TRes
]
>
;
setTelemetryCollector
:
(
collector
:
TelemetryCollector
|
null
)
=>
void
;
}
Implemented by
TeleforgeEventBus
Index
Methods
emit
off
on
once
request
Properties
publish
To
Bot
set
Telemetry
Collector
Methods
emit
emit
<
TType
extends
EventType
>
(
type
:
TType
,
payload
:
TeleforgeEventMap
[
TType
]
,
options
?:
EmitEventOptions
,
)
:
TeleforgeEvent
<
TType
>
Type Parameters
TType
extends
EventType
Parameters
type
:
TType
payload
:
TeleforgeEventMap
[
TType
]
Optional
options
:
EmitEventOptions
Returns
TeleforgeEvent
<
TType
>
emit
<
TType
extends
string
,
TPayload
>
(
event
:
TeleforgeEventInput
<
TType
,
TPayload
>
,
)
:
TeleforgeEvent
<
TType
,
TPayload
>
Type Parameters
TType
extends
string
TPayload
Parameters
event
:
TeleforgeEventInput
<
TType
,
TPayload
>
Returns
TeleforgeEvent
<
TType
,
TPayload
>
off
off
<
TType
extends
string
,
TPayload
=
EventPayload
<
TType
>
>
(
type
:
TType
,
handler
:
EventHandler
<
TPayload
,
TType
>
,
)
:
void
Type Parameters
TType
extends
string
TPayload
=
EventPayload
<
TType
>
Parameters
type
:
TType
handler
:
EventHandler
<
TPayload
,
TType
>
Returns
void
on
on
<
TType
extends
string
,
TPayload
=
EventPayload
<
TType
>
>
(
type
:
TType
,
handler
:
EventHandler
<
TPayload
,
TType
>
,
)
:
()
=>
void
Type Parameters
TType
extends
string
TPayload
=
EventPayload
<
TType
>
Parameters
type
:
TType
handler
:
EventHandler
<
TPayload
,
TType
>
Returns
()
=>
void
once
once
<
TType
extends
string
,
TPayload
=
EventPayload
<
TType
>
>
(
type
:
TType
,
handler
:
EventHandler
<
TPayload
,
TType
>
,
)
:
()
=>
void
Type Parameters
TType
extends
string
TPayload
=
EventPayload
<
TType
>
Parameters
type
:
TType
handler
:
EventHandler
<
TPayload
,
TType
>
Returns
()
=>
void
request
request
<
TReq
extends
EventType
,
TRes
extends
EventType
>
(
requestType
:
TReq
,
payload
:
TeleforgeEventMap
[
TReq
]
,
responseType
:
TRes
,
timeoutMs
?:
number
,
options
?:
EmitEventOptions
,
)
:
Promise
<
TeleforgeEventMap
[
TRes
]
>
Type Parameters
TReq
extends
EventType
TRes
extends
EventType
Parameters
requestType
:
TReq
payload
:
TeleforgeEventMap
[
TReq
]
responseType
:
TRes
Optional
timeoutMs
:
number
Optional
options
:
EmitEventOptions
Returns
Promise
<
TeleforgeEventMap
[
TRes
]
>
Properties
publish
To
Bot
publishToBot
:
(
payload
:
unknown
)
=>
void
set
Telemetry
Collector
setTelemetryCollector
:
(
collector
:
TelemetryCollector
|
null
)
=>
void
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Methods
emit
off
on
once
request
Properties
publish
To
Bot
set
Telemetry
Collector
Teleforge API Reference - v0.1.0
Loading...