faastjs.proxymodule.md

id	title	hide_title
faastjs.proxymodule	ProxyModule type	true

faastjs > ProxyModule

ProxyModule type

ProxyModule<M> is the type of FaastModule.functions.

Signature:

export type ProxyModule<M> = {
    [K in keyof M]: M[K] extends (...args: infer A) => infer R ? (...args: A) => Async<R> : never;
};

References: Async

Remarks

ProxyModule<M> maps an imported module's functions to promise-returning or async-iteratable versions of those functions. Non-function exports of the module are omitted. When invoked, the functions in a ProxyModule invoke a remote cloud function.