Teleforge API Reference - v0.1.0
Preparing search index...
core/src
TeleforgeEventBus
Class TeleforgeEventBus
Implements
EventBus
Index
Constructors
constructor
Methods
emit
off
on
once
publish
To
Bot
request
set
Telemetry
Collector
Constructors
constructor
new
TeleforgeEventBus
(
options
?:
TeleforgeEventBusOptions
)
:
TeleforgeEventBus
Parameters
options
:
TeleforgeEventBusOptions
= {}
Returns
TeleforgeEventBus
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
=
unknown
>
(
type
:
TType
,
handler
:
EventHandler
<
TPayload
,
TType
>
,
)
:
void
Type Parameters
TType
extends
string
TPayload
=
unknown
Parameters
type
:
TType
handler
:
EventHandler
<
TPayload
,
TType
>
Returns
void
on
on
<
TType
extends
string
,
TPayload
=
unknown
>
(
type
:
TType
,
handler
:
EventHandler
<
TPayload
,
TType
>
,
)
:
()
=>
void
Type Parameters
TType
extends
string
TPayload
=
unknown
Parameters
type
:
TType
handler
:
EventHandler
<
TPayload
,
TType
>
Returns
()
=>
void
once
once
<
TType
extends
string
,
TPayload
=
unknown
>
(
type
:
TType
,
handler
:
EventHandler
<
TPayload
,
TType
>
,
)
:
()
=>
void
Type Parameters
TType
extends
string
TPayload
=
unknown
Parameters
type
:
TType
handler
:
EventHandler
<
TPayload
,
TType
>
Returns
()
=>
void
publish
To
Bot
publishToBot
(
payload
:
unknown
)
:
void
Parameters
payload
:
unknown
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
timeoutMs
:
number
= 5000
options
:
EmitEventOptions
= {}
Returns
Promise
<
TeleforgeEventMap
[
TRes
]
>
set
Telemetry
Collector
setTelemetryCollector
(
collector
:
TelemetryCollector
|
null
)
:
void
Parameters
collector
:
TelemetryCollector
|
null
Returns
void
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
emit
off
on
once
publish
To
Bot
request
set
Telemetry
Collector
Teleforge API Reference - v0.1.0
Loading...