faastjs > FaastModuleProxy > cleanup

FaastModuleProxy.cleanup() method

Stop the faast.js runtime for this cloud function and clean up ephemeral cloud resources.

Signature:

cleanup(userCleanupOptions?: CleanupOptions): Promise<void>;

Parameters

Parameter	Type	Description
userCleanupOptions	CleanupOptions	(Optional)

**Returns:**

Promise<void>

a Promise that resolves when the FaastModule runtime stops and ephemeral resources have been deleted.

Remarks

It is best practice to always call cleanup when done with a cloud function. A typical way to ensure this in normal execution is to use the finally construct:

const faastModule = await faast("aws", m);
try {
    // Call faastModule.functions.*
} finally {
    // Note the `await`
    await faastModule.cleanup();
}

After the cleanup promise resolves, the cloud function instance can no longer invoke new calls on FaastModule.functions. However, other methods on FaastModule are safe to call, such as FaastModule.costSnapshot().

Cleanup also stops statistics events (See FaastModule.off()).

By default, cleanup will delete all ephemeral cloud resources but leave behind cached resources for use by future cloud functions. Deleted resources typically include cloud functions, queues, and queue subscriptions. Logs are not deleted by cleanup.

Note that cleanup leaves behind some provider-specific resources:

• AWS: Cloudwatch logs are preserved until the garbage collector in a future cloud function instance deletes them. The default log expiration time is 24h (or the value of CommonOptions.retentionInDays). In addition, the AWS Lambda IAM role is not deleted by cleanup. This role is shared across cloud function instances. Lambda layers are also not cleaned up immediately on AWS when CommonOptions.packageJson is used and CommonOptions.useDependencyCaching is true. Cached layers are cleaned up by garbage collection. Also see CleanupOptions.deleteCaches.

• Local: Logs are preserved in a temporary directory on local disk. Garbage collection in a future cloud function instance will delete logs older than 24h.