Skip to main content

Class: CustomRefMessage<T, I>

Defined in: messages/CustomRefMessage.ts:15

Extends​

Type Parameters​

• T = any

• I extends scriptInputs = customRefScriptInputs

Constructors​

new CustomRefMessage()​

new CustomRefMessage<T, I>(script, scriptInputs, handler): CustomRefMessage<T, I>

Defined in: messages/CustomRefMessage.ts:17

Parameters​

script​

(vars) => T

scriptInputs​

I & customRefScriptInputs

handler​

(message) => void

Returns​

CustomRefMessage<T, I>

Overrides​

ExecuteScriptMessage.constructor

Properties​

cleanable​

cleanable: boolean = false

Defined in: messages/BaseMessage.ts:44

Inherited from​

ExecuteScriptMessage.cleanable

content?​

optional content: string

Defined in: messages/BaseMessage.ts:32

Inherited from​

ExecuteScriptMessage.content

destination?​

optional destination: string

Defined in: messages/BaseMessage.ts:36

Inherited from​

ExecuteScriptMessage.destination

direction?​

optional direction: MessageDirectionOption

Defined in: messages/BaseMessage.ts:42

Inherited from​

ExecuteScriptMessage.direction

handler()​

handler: (message) => void

Defined in: messages/BaseMessage.ts:69

Parameters​

message​

ExecuteScriptReplyMessage<T>

Returns​

void

Inherited from​

ExecuteScriptMessage.handler

handlerUniqueId​

handlerUniqueId: string

Defined in: messages/BaseMessage.ts:67

Inherited from​

ExecuteScriptMessage.handlerUniqueId

id​

id: string

Defined in: messages/BaseMessage.ts:14

Inherited from​

ExecuteScriptMessage.id

messageType​

messageType: string = 'ExecuteScriptMessage'

Defined in: messages/ExecuteScriptMessage.ts:40

Inherited from​

ExecuteScriptMessage.messageType

myop​

myop: boolean = true

Defined in: messages/BaseMessage.ts:28

Inherited from​

ExecuteScriptMessage.myop

ref?​

optional ref: Ref

Defined in: messages/BaseMessage.ts:40

Inherited from​

ExecuteScriptMessage.ref

replyMessageKey​

replyMessageKey: MyopMessageKey = ReplayMessageKey

Defined in: messages/ExecuteScriptMessage.ts:39

Inherited from​

ExecuteScriptMessage.replyMessageKey

route?​

optional route: string[]

Defined in: messages/BaseMessage.ts:38

Inherited from​

ExecuteScriptMessage.route

script​

script: string = ''

Defined in: messages/ExecuteScriptMessage.ts:41

Inherited from​

ExecuteScriptMessage.script

scriptInputs​

scriptInputs: I & customRefScriptInputs

Defined in: messages/CustomRefMessage.ts:18

Inherited from​

ExecuteScriptMessage.scriptInputs

source?​

optional source: string

Defined in: messages/BaseMessage.ts:35

Inherited from​

ExecuteScriptMessage.source

completeStreamKey​

static completeStreamKey: string = 'completeStream'

Defined in: messages/ExecuteScriptMessage.ts:44

Inherited from​

ExecuteScriptMessage.completeStreamKey

replierKey​

static replierKey: string = 'send'

Defined in: messages/ExecuteScriptMessage.ts:43

Inherited from​

ExecuteScriptMessage.replierKey

Methods​

isTypeof()​

isTypeof(msg): boolean

Defined in: messages/BaseMessage.ts:46

Parameters​

msg​

BaseMyopMessage

Returns​

boolean

Inherited from​

ExecuteScriptMessage.isTypeof

create()​

static create<T, U>(this, ...args): InstanceType<U>

Defined in: messages/BaseMessage.ts:16

Type Parameters​

• T

• U extends (...args) => T = U

Parameters​

this​

U

args​

...ConstructorParameters<U>

Returns​

InstanceType<U>

Inherited from​

ExecuteScriptMessage.create