FaastModule.functions property

Each call of a cloud function creates a separate remote invocation.

Signature:

functions: ProxyModule<M>;

Remarks

The module passed into faast() or its provider-specific variants (faastAws() and faastLocal()) is mapped to a ProxyModule version of the module, which performs the following mapping:

All function exports that are generators are mapped to async generators.
All function exports that return async generators are preserved as-is.
All function exports that return promises have their type signatures preserved as-is.
All function exports that return type T, where T is not a Promise, Generator, or AsyncGenerator, are mapped to functions that return Promise. Argument types are preserved as-is.
All non-function exports are omitted in the remote module.

Arguments and return values are serialized with JSON.stringify when cloud functions are called, therefore what is received on the remote side might not match what was sent. Faast.js attempts to detect nonsupported arguments on a best effort basis.

If the cloud function throws an exception or rejects its promise with an instance of Error, then the function will reject with FaastError on the local side. If the exception or rejection resolves to any value that is not an instance of Error, the remote function proxy will reject with the value of JSON.parse(JSON.stringify(err)).

Arguments and return values have size limitations that vary by provider and mode:

AWS: 256KB in queue mode, 6MB arguments and 256KB return values in https mode. See AWS Lambda Limits.
Local: limited only by available memory and the limits of childprocess.send.

Note that payloads may be base64 encoded for some providers and therefore different in size than the original payload. Also, some bookkeeping data are passed along with arguments and contribute to the size limit.