faastjs package
Faast.js transforms ordinary JavaScript modules into serverless cloud functions that can run on AWS Lambda.
The main entry point to faast.js is the faast() function, which returns an object that implements the FaastModule interface. The most common options are CommonOptions. Using faast.js requires writing two modules, one containing the functions to upload to the cloud, and the other that invokes faast.js and calls the resulting cloud functions.
Classes
| Class | Description |
|---|---|
| CostMetric | A line item in the cost estimate, including the resource usage metric measured and its pricing. |
| CostSnapshot | A summary of the costs incurred by a faast.js module at a point in time. Output of FaastModule.costSnapshot(). |
| FaastError | FaastError is a subclass of VError (https://github.com/joyent/node-verror). that is thrown by faast.js APIs and cloud function invocations. |
| FaastModuleProxy | Implementation of FaastModule. |
| FunctionStats | Summary statistics for function invocations. |
| FunctionStatsEvent | Summarize statistics about cloud function invocations. |
| PersistentCache | A simple persistent key-value store. Used to implement Limits.cache for throttle(). |
| Statistics | Incrementally updated statistics on a set of values. |
Enumerations
| Enumeration | Description |
|---|---|
| FaastErrorNames | Possible FaastError names. See FaastError. To test for errors matching these names, use the static method FaastError.hasCauseWithName(). |
Functions
| Function | Description |
|---|---|
| faast(provider, fmodule, options) | The main entry point for faast with any provider and only common options. |
| faastAws(fmodule, options) | The main entry point for faast with AWS provider. |
| faastLocal(fmodule, options) | The main entry point for faast with Local provider. |
| throttle(limits, fn) | A decorator for rate limiting, concurrency limiting, retry, memoization, and on-disk caching. See Limits. |
Interfaces
| Interface | Description |
|---|---|
| AwsClientFactory | Factory for AWS service clients, which allows for custom construction and configuration. AWS Configuration. |
| AwsOptions | AWS-specific options for faastAws(). |
| CleanupOptions | Options that apply to the FaastModule.cleanup() method. |
| CommonOptions | Options common across all faast.js providers. Used as argument to faast(). |
| Detail | A function return value with additional detailed information. |
| FaastModule | The main interface for invoking, cleaning up, and managing faast.js cloud functions. Returned by faast(). |
| IncludeOption | Options for the CommonOptions.include option. |
| Limits | Specify throttle() limits. These limits shape the way throttle invokes the underlying function. |
| LocalOptions | Local provider options for faastLocal(). |
Namespaces
| Namespace | Description |
|---|---|
| CostAnalyzer | Analyze the cost of a workload across many provider configurations. |
Variables
| Variable | Description |
|---|---|
| log | Faast.js loggers. |
| providers | An array of all available provider. |
Type Aliases
| Type Alias | Description |
|---|---|
| Async | Async<T> maps regular values to Promises and Iterators to AsyncIterators, If T is already a Promise or an AsyncIterator, it remains the same. This type is used to infer the return value of cloud functions from the types of the functions in the user's input module. |
| AsyncDetail | AsyncDetail<T> is similar to Async except it maps retun values R to Detail<R>, which is the return value with additional information about each cloud function invocation. |
| AwsFaastModule | The return type of faastAws(). See FaastModuleProxy. |
| AwsRegion | Valid AWS regions. Not all of these regions have Lambda support. |
| LocalFaastModule | The return type of faastLocal(). See FaastModuleProxy. |
| Provider | The type of all supported cloud providers. |
| ProxyModule | ProxyModule<M> is the type of FaastModule.functions. |
| ProxyModuleDetail | Similar to ProxyModule except each function returns a Detail object. |