@proto-kit/module • Docs
Documentation / @proto-kit/module / OutgoingMessages
Class: OutgoingMessages<Messages>
Extends
WithPath<this> &WithStateServiceProvider<this>
Type Parameters
• Messages extends OutgoingMessagesRecord
Constructors
new OutgoingMessages()
new OutgoingMessages<
Messages>(messages):OutgoingMessages<Messages>
Parameters
• messages: Messages
Returns
OutgoingMessages<Messages>
Overrides
Mixin(WithPath, WithStateServiceProvider).constructor
Defined in
packages/module/src/messages/OutgoingMessages.ts:43
Properties
eventTypes
readonlyeventTypes:Record<string,object>
Defined in
packages/module/src/messages/OutgoingMessages.ts:31
path?
optionalpath:Field
Inherited from
Mixin(WithPath, WithStateServiceProvider).path
Defined in
packages/protocol/dist/state/State.d.ts:6
stateServiceProvider?
optionalstateServiceProvider:StateServiceProvider
Inherited from
Mixin(WithPath, WithStateServiceProvider).stateServiceProvider
Defined in
packages/protocol/dist/state/State.d.ts:12
Methods
computeEventTypes()
computeEventTypes():
object
Returns
object
Defined in
packages/module/src/messages/OutgoingMessages.ts:59
emitMessage()
emitMessage<
Key>(key,value,tokenId):Promise<void>
Type Parameters
• Key extends string
Parameters
• key: Key
• value: InferProvable<Messages[Key], Field>
• tokenId: Field = TokenId.default
Returns
Promise<void>
Defined in
packages/module/src/messages/OutgoingMessages.ts:97
hasPathOrFail()
hasPathOrFail():
asserts this is Object
Returns
asserts this is Object
Inherited from
Mixin(WithPath, WithStateServiceProvider).hasPathOrFail
Defined in
packages/protocol/dist/state/State.d.ts:7
hasStateServiceOrFail()
hasStateServiceOrFail():
asserts this is Object
Returns
asserts this is Object
Inherited from
Mixin(WithPath, WithStateServiceProvider).hasStateServiceOrFail
Defined in
packages/protocol/dist/state/State.d.ts:13
getEventName()
staticgetEventName(key):string
Parameters
• key: string
Returns
string