PURISTA API

---

PURISTA API / @purista/core / InvokeFunction

Type Alias: InvokeFunction()

InvokeFunction = <InvokeResponseType, PayloadType, ParameterType>(address, payload, parameter) => Promise<InvokeResponseType>

Defined in: packages/core/src/core/types/InvokeFunction.ts:23

Invokes a command and returns the result. It is recommended to validate the result against a schema which only contains the data you actually need.

Type Parameters

InvokeResponseType

InvokeResponseType = unknown

PayloadType

PayloadType = unknown

ParameterType

ParameterType extends EmptyObject = EmptyObject

Parameters

address

EBMessageAddress

payload

PayloadType

parameter

ParameterType

Returns

Promise<InvokeResponseType>

Example

const address: EBMessageAddress = {
  serviceName: 'name-of-service-to-invoke',
  serviceVersion: '1',
  serviceTarget: 'command-name-to-invoke',
}

const inputPayload = { my: 'input' }
const inputParameter = { search: 'for_me' }

const result = await invoke<MyResultType>(address, inputPayload inputParameter )