Class FunctionService

Service for interacting with functions

Hierarchy (View Summary)

MessageInvokerService
- FunctionService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

createFunction functions getFunctionDescription postAndAwait postAndObserve request requestObserve

Constructors

constructor

new FunctionService(eventTarget: EventTargetOrCommChannel): FunctionService
Create a service for the specific worker
Parameters
- eventTarget: EventTargetOrCommChannel
Returns FunctionService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/function.service.d.ts:13

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

createFunction

createFunction(name: string, moduleName?: string): Promise<FunctionDeclaration>
Create a new function declaration
Parameters
- name: string
  Actual name of the function. Might be changed by the service to avoid name clashes
- OptionalmoduleName: string
Returns Promise<FunctionDeclaration>
Promise resolving to the created function declaration
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/function.service.d.ts:23

functions

functions(): Observable<FunctionDescriptionWithReference[]>
Get a list of available variables

Returns Observable<FunctionDescriptionWithReference[]>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/function.service.d.ts:17

getFunctionDescription

getFunctionDescription(
reference: FunctionReference,
): Promise<FunctionDescriptionWithReference | undefined>
Get a function description from its reference
Parameters
- reference: FunctionReference
  the function reference
Returns Promise<FunctionDescriptionWithReference | undefined>
Promise resolving to the function description or undefined if not found
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/function.service.d.ts:29

postAndAwait

postAndAwait<T>(type: string, data?: any): Promise<T>
returns a reply promise to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.postAndAwait
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:192

postAndObserve

postAndObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.postAndObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:199

request

request<T>(type: string, data?: any): Promise<T>
returns a reply promise for the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.request
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:178

requestObserve

requestObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.requestObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:185