faastjs.faastmodule.md

id	title	hide_title
faastjs.faastmodule	FaastModule interface	true

faastjs > FaastModule

FaastModule interface

The main interface for invoking, cleaning up, and managing faast.js cloud functions. Returned by faast().

Signature:

export interface FaastModule<M extends object> 

Properties

Property	Modifiers	Type	Description
functions		ProxyModule<M>	Each call of a cloud function creates a separate remote invocation.
functionsDetail		ProxyModuleDetail<M>	Similar to FaastModule.functions except each function returns a Detail object
provider		Provider	See Provider.

Methods

Method	Description
cleanup(options)	Stop the faast.js runtime for this cloud function and clean up ephemeral cloud resources.
costSnapshot()	Get a near real-time cost estimate of cloud function invocations.
logUrl()	The URL of logs generated by this cloud function.
off(name, listener)	Deregister a callback for statistics events.
on(name, listener)	Register a callback for statistics events.
stats(functionName)	Statistics for a specific function or the entire faast.js module.