@webda/aws • Readme | API

---

Class: LambdaCaller<T>

A service that calls a Lambda function and retrieve its result

Webda Modda

Extends

• Runner<T>

Type parameters

• T extends LambdaCallerParameters = LambdaCallerParameters

Constructors

new LambdaCaller(webda, name, params)

new LambdaCaller<T>(webda, name, params?): LambdaCaller<T>

Parameters

• webda: Core<CoreEvents>

The main instance of Webda

• name: string

The name of the service

• params?: DeepPartial<T>

The parameters block define in the configuration file

Returns

LambdaCaller<T>

Inherited from

Runner<T>.constructor

Source

packages/core/lib/services/service.d.ts:168

Properties

_createException

_createException: string

Inherited from

Runner._createException

Source

packages/core/lib/services/service.d.ts:149

---

_initException

_initException: any

Inherited from

Runner._initException

Source

packages/core/lib/services/service.d.ts:151

---

_initTime

_initTime: number

Inherited from

Runner._initTime

Source

packages/core/lib/services/service.d.ts:150

---

_name

protected _name: string

Service name

Inherited from

Runner._name

Source

packages/core/lib/services/service.d.ts:142

---

_webda

protected _webda: Core<CoreEvents>

Webda Core object

Inherited from

Runner._webda

Source

packages/core/lib/services/service.d.ts:138

---

client

protected client: Lambda

Lambda client

Source

packages/aws/src/services/lambdacaller.ts:56

---

logger

protected logger: Logger

Logger with class context

Inherited from

Runner.logger

Source

packages/core/lib/services/service.d.ts:155

---

metrics?

protected metrics?: any

Get metrics

Inherited from

Runner.metrics

Source

packages/core/lib/services/service.d.ts:159

---

parameters

protected parameters: T

Hold the parameters for your service

It will be bring from the webda.config.json

Inherited from

Runner.parameters

Source

packages/core/lib/services/service.d.ts:148

---

captureRejectionSymbol

static readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

Runner.captureRejectionSymbol

Source

node_modules/@types/node/events.d.ts:38

---

captureRejections

static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

Runner.captureRejections

Source

node_modules/@types/node/events.d.ts:44

---

defaultMaxListeners

static defaultMaxListeners: number

Inherited from

Runner.defaultMaxListeners

Source

node_modules/@types/node/events.d.ts:45

---

errorMonitor

static readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Inherited from

Runner.errorMonitor

Source

node_modules/@types/node/events.d.ts:37

Methods

__clean()

__clean(): Promise<void>

Clean the service data, can only be used in test mode

Returns

Promise<void>

Inherited from

Runner.__clean

Abstract

Source

packages/core/lib/services/service.d.ts:319

---

addListener()

addListener(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Runner.addListener

Source

node_modules/@types/node/events.d.ts:57

---

addRoute()

protected addRoute(url, methods, executer, openapi?, override?): void

Add a route dynamicaly

Parameters

• url: string

of the route can contains dynamic part like {uuid}

• methods: HttpMethodType[]

• executer: Function

Method to execute for this route

• openapi?: OpenAPIWebdaDefinition

• override?: boolean

Returns

void

Inherited from

Runner.addRoute

Source

packages/core/lib/services/service.d.ts:242

---

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Authorize a public event subscription

Parameters

• _event: string

• _context: OperationContext<any, any>

Returns

boolean

Inherited from

Runner.authorizeClientEvent

Source

packages/core/lib/services/service.d.ts:220

---

computeParameters()

computeParameters(): void

Used to compute or derivate input parameter to attribute

Returns

void

Inherited from

Runner.computeParameters

Source

packages/core/lib/services/service.d.ts:176

---

emit()

emit<Key>(event, data): boolean

Override to allow capturing long listeners

Type parameters

• Key extends string | number

Parameters

• event: symbol | Key

• data: Events[Key]

Returns

boolean

Inherited from

Runner.emit

Source

packages/core/lib/services/service.d.ts:289

---

emitSync()

emitSync<Key>(event, data): Promise<any[]>

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type parameters

• Key extends string | number

Parameters

• event: Key

• data: Events[Key]

Returns

Promise<any[]>

Inherited from

Runner.emitSync

Source

packages/core/lib/services/service.d.ts:284

---

eventNames()

eventNames(): (string | symbol)[]

Returns

(string | symbol)[]

Inherited from

Runner.eventNames

Source

node_modules/@types/node/events.d.ts:72

---

execute()

execute(params, async, arn): Promise<any>

Execute the Lambda function

Parameters

• params: any= {}

for the call

• async: boolean= false

wait for Lambda result

• arn: string= undefined

function to call default to the one from configuration

Returns

Promise<any>

Source

packages/aws/src/services/lambdacaller.ts:81

---

getClientEvents()

getClientEvents(): string[]

Return the events that an external system can subscribe to

Returns

string[]

Inherited from

Runner.getClientEvents

Source

packages/core/lib/services/service.d.ts:214

---

getMaxListeners()

getMaxListeners(): number

Returns

number

Inherited from

Runner.getMaxListeners

Source

node_modules/@types/node/events.d.ts:64

---

getMetric()

getMetric<T>(type, configuration): T

Add service name label

Type parameters

• T = Counter<string> | Histogram<string> | Gauge<string>

Parameters

• type: Constructor<T, [MetricConfiguration<T>]>

• configuration: MetricConfiguration<T>

Returns

T

Inherited from

Runner.getMetric

Source

packages/core/lib/services/service.d.ts:208

---

getName()

getName(): string

Get service name

Returns

string

Inherited from

Runner.getName

Source

packages/core/lib/services/service.d.ts:313

---

getOpenApiReplacements()

getOpenApiReplacements(): any

Return variables for replacement in openapi

Returns

any

Inherited from

Runner.getOpenApiReplacements

Source

packages/core/lib/services/service.d.ts:247

---

getOperationId()

getOperationId(id): string

If undefined is returned it cancel the operation registration

Parameters

• id: string

Returns

string

Inherited from

Runner.getOperationId

Source

packages/core/lib/services/service.d.ts:234

---

getParameters()

getParameters(): T

Get the service parameters

Returns

T

Inherited from

Runner.getParameters

Source

packages/core/lib/services/service.d.ts:180

---

getService()

getService<K>(service): K

Return a webda service

Type parameters

• K extends Service<ServiceParameters, Events>

Parameters

• service: string

name to retrieve

Returns

K

Inherited from

Runner.getService

Source

packages/core/lib/services/service.d.ts:309

---

getUrl()

getUrl(url, _methods): string

Return the full path url based on parameters

Parameters

• url: string

relative url to service

• _methods: HttpMethodType[]

in case we need filtering (like Store)

Returns

string

absolute url or undefined if need to skip the Route

Inherited from

Runner.getUrl

Source

packages/core/lib/services/service.d.ts:228

---

getWebda()

getWebda(): Core<CoreEvents>

Return WebdaCore

Returns

Core<CoreEvents>

Inherited from

Runner.getWebda

Source

packages/core/lib/services/service.d.ts:184

---

handleType()

handleType(type): boolean

Handle this type of action

Parameters

• type: string

Returns

boolean

Inherited from

Runner.handleType

Source

packages/async/lib/services/runner.d.ts:41

---

init()

init(): Promise<LambdaCaller<T>>

Will be called after all the Services are created

Returns

Promise<LambdaCaller<T>>

Inherited from

Runner.init

Abstract

Source

packages/core/lib/services/service.d.ts:275

---

initMetrics()

initMetrics(): void

Init the metrics

Returns

void

Inherited from

Runner.initMetrics

Source

packages/core/lib/services/service.d.ts:201

---

initOperations()

initOperations(): void

Init the operations

Returns

void

Inherited from

Runner.initOperations

Source

packages/core/lib/services/service.d.ts:255

---

initRoutes()

initRoutes(): void

Init the routes

Returns

void

Inherited from

Runner.initRoutes

Source

packages/core/lib/services/service.d.ts:251

---

launchAction()

launchAction(action, info): Promise<any>

Parameters

• action: default

• info: JobInfo

Returns

Promise<any>

Overrides

Runner.launchAction

Inherit Doc

Source

packages/aws/src/services/lambdacaller.ts:36

---

listenerCount()

listenerCount(event): number

Parameters

• event: string | symbol

Returns

number

Inherited from

Runner.listenerCount

Source

node_modules/@types/node/events.d.ts:68

---

listeners()

listeners(event): Function[]

Parameters

• event: string | symbol

Returns

Function[]

Inherited from

Runner.listeners

Source

node_modules/@types/node/events.d.ts:65

---

loadParameters()

loadParameters(params): ServiceParameters

Parameters

• params: any

Returns

ServiceParameters

Overrides

Runner.loadParameters

Inherit Doc

Source

packages/aws/src/services/lambdacaller.ts:61

---

log()

log(level, ...args): void

Parameters

• level: WorkerLogLevel

to log

• ...args: any[]

Returns

void

Inherited from

Runner.log

Source

packages/core/lib/services/service.d.ts:329

---

off()

off(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Runner.off

Source

node_modules/@types/node/events.d.ts:61

---

on()

on<Key>(event, listener): this

Type the listener part

Type parameters

• Key extends string | number

Parameters

• event: symbol | Key

• listener: (evt) => void

Returns

this

Inherited from

Runner.on

Source

packages/core/lib/services/service.d.ts:297

---

onAsync()

onAsync<Key>(event, listener, queue?): void

Listen to an event as on(...) would do except that it will be asynchronous

Type parameters

• Key extends string | number

Parameters

• event: Key

• listener: (evt) => void

• queue?: string

Name of queue to use, can be undefined, queue name are used to define differents priorities

Returns

void

Inherited from

Runner.onAsync

Source

packages/core/lib/services/service.d.ts:304

---

once()

once(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Runner.once

Source

node_modules/@types/node/events.d.ts:59

---

prependListener()

prependListener(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Runner.prependListener

Source

node_modules/@types/node/events.d.ts:70

---

prependOnceListener()

prependOnceListener(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Runner.prependOnceListener

Source

node_modules/@types/node/events.d.ts:71

---

rawListeners()

rawListeners(event): Function[]

Parameters

• event: string | symbol

Returns

Function[]

Inherited from

Runner.rawListeners

Source

node_modules/@types/node/events.d.ts:66

---

reinit()

reinit(config): Promise<LambdaCaller<T>>

Parameters

• config: DeepPartial<T>

new parameters for the service

Returns

Promise<LambdaCaller<T>>

Inherited from

Runner.reinit

Source

packages/core/lib/services/service.d.ts:280

---

removeAllListeners()

removeAllListeners(event?): this

Parameters

• event?: string | symbol

Returns

this

Inherited from

Runner.removeAllListeners

Source

node_modules/@types/node/events.d.ts:62

---

removeListener()

removeListener(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Runner.removeListener

Source

node_modules/@types/node/events.d.ts:60

---

resolve()

resolve(): this

Returns

this

Overrides

Runner.resolve

Inherit Doc

Source

packages/aws/src/services/lambdacaller.ts:68

---

setMaxListeners()

setMaxListeners(n): this

Parameters

• n: number

Returns

this

Inherited from

Runner.setMaxListeners

Source

node_modules/@types/node/events.d.ts:63

---

stop()

stop(): Promise<void>

Shutdown the current service if action need to be taken

Returns

Promise<void>

Inherited from

Runner.stop

Source

packages/core/lib/services/service.d.ts:188

---

toJSON()

toJSON(): string

Prevent service to be serialized

Returns

string

Inherited from

Runner.toJSON

Source

packages/core/lib/services/service.d.ts:268

---

toPublicJSON()

toPublicJSON(object): string

Convert an object to JSON using the Webda json filter

Parameters

• object: unknown

The object to export

Returns

string

The export of the strip object ( removed all attribute with _ )

Inherited from

Runner.toPublicJSON

Source

packages/core/lib/services/service.d.ts:263

---

toString()

toString(): string

Return service representation

Returns

string

Inherited from

Runner.toString

Source

packages/core/lib/services/service.d.ts:192

---

getAgentInfo()

static getAgentInfo(): AgentInfo

Return agent information

Returns

AgentInfo

Inherited from

Runner.getAgentInfo

Source

packages/async/lib/services/runner.d.ts:46

---

listenerCount()

static listenerCount(emitter, event): number

Parameters

• emitter: EventEmitter

• event: string | symbol

Returns

number

Inherited from

Runner.listenerCount

Deprecated

since v4.0.0

Source

node_modules/@types/node/events.d.ts:26

---

on()

static on(emitter, event): AsyncIterableIterator<any>

Parameters

• emitter: EventEmitter

• event: string

Returns

AsyncIterableIterator<any>

Inherited from

Runner.on

Source

node_modules/@types/node/events.d.ts:23

---

once()

once(emitter, event)

static once(emitter, event): Promise<any[]>

Parameters

• emitter: NodeEventTarget

• event: string | symbol

Returns

Promise<any[]>

Inherited from

Runner.once

Source

node_modules/@types/node/events.d.ts:21

once(emitter, event)

static once(emitter, event): Promise<any[]>

Parameters

• emitter: DOMEventTarget

• event: string

Returns

Promise<any[]>

Inherited from

Runner.once

Source

node_modules/@types/node/events.d.ts:22