@aws-nx/functions v1.0.1

Functions Documentation

The @aws-nx/functions is a tool within Nx workspaces to build, bundle, and package serverless functions.

Table of Contents

1. Generate App
2. Generate Library
3. Remove Application
4. Remove Function
5. Execute Build

Installation

The @aws-nx/functions library can be installed via npm. It provides tools for generating, managing, and removing AWS CDK applications and functions within Nx workspaces. To install, use the following command:

npm i @aws-nx/functions

1. Generate Application

To generate a new application, execute the following command:

nx g @aws-nx/functions:app <Function_Name> --project <Project_Name>

Options:

• --project (required): Specify project name.
• --bundle (optional): Bundle project on build.
• --tag (optional): Specify tags for project

2. Generate Library

Generate through prompt:

nx g lib

To generate a new library, execute the following command:

nx g @aws-nx/functions:lib <Function_Name> --project <Project_Name>

Options:

• --project (required): Specify project name.
• --bundle (optional): Bundle project on build.
• --tag (optional): Specify tags for project

3. Remove Application

To remove an application, use one of the following commands:

nx g @aws-nx/functions:remove <APP_NAME>

or

nx g @aws-nx/functions:remove --project <APP_NAME>

4. Remove Function

To remove a single function from an existing application, use one of the following commands:

nx g @aws-nx/functions:remove <Project_Name> --function <Function_Name>

or

nx g @aws-nx/functions:remove --function <Function_Name> --project <Project_Name>