faastjs.faast.md

id	title	hide_title
faastjs.faast	faast() function	true

faastjs > faast

faast() function

The main entry point for faast with any provider and only common options.

Signature:

export declare function faast<M extends object>(provider: Provider, fmodule: M, options?: CommonOptions): Promise<FaastModule<M>>;

Parameters

Parameter	Type	Description
provider	Provider	One of "aws" or "local". See Provider.
fmodule	M	A module imported with import * as X from "Y";. Using require also works but loses type information.
options	CommonOptions	(Optional) See CommonOptions.

**Returns:**

Promise<FaastModule<M>>

See FaastModule.

Remarks

Example of usage:

import { faast } from "faastjs";
import * as mod from "./path/to/module";
(async () => {
    const faastModule = await faast("aws", mod);
    try {
        const result = await faastModule.functions.func("arg");
    } finally {
        await faastModule.cleanup();
    }
})();