faastjs.faastlocal.md

April 5, 2024 ยท View on GitHub

faastjs > faastLocal

faastLocal() function

The main entry point for faast with Local provider.

Signature:

export declare function faastLocal<M extends object>(fmodule: M, options?: LocalOptions): Promise<LocalFaastModule<M>>;

Parameters

Parameter

Type

Description

fmodule

M

A module imported with import * as X from "Y";. Using require also works but loses type information.

options

LocalOptions

(Optional) Most common options are in CommonOptions. Additional Local-specific options are in LocalOptions.

**Returns:**

Promise<LocalFaastModule<M>>

a Promise for LocalFaastModule.