Documents / @faasjs/test / Func

Class: Func<TEvent, TContext, TResult>

Type Parameters

TEvent

TEvent = any

TContext

TContext = any

TResult

TResult = any

Indexable

[key: string]: any

Constructors

Constructor

new Func<TEvent, TContext, TResult>(config): Func<TEvent, TContext, TResult>

Create a cloud function

Parameters

config

FuncConfig<TEvent, TContext>

{object} config

Returns

Func<TEvent, TContext, TResult>

Methods

export()

export(): object

Export the function

Returns

object

handler

handler: ExportedHandler<TEvent, TContext, TResult>

invoke()

invoke(data): Promise<void>

Invoke the function

Parameters

data

InvokeData<TEvent, TContext, TResult>

{object} data

Returns

Promise<void>

mount()

mount(data): Promise<void>

First time mount the function

Parameters

data

config?

Config

context

TContext

event

TEvent

logger?

Logger

Returns

Promise<void>

Properties

config

config: Config

filename?

optional filename: string

handler?

optional handler: Handler<TEvent, TContext, TResult>

mounted

mounted: boolean = false

plugins

plugins: Plugin[]