macpro-serverless-running-stages

NPM module to identify currently running stages of the Serverless framework in an AWS account.

latest release npm latest version semantic-release: angular Dependabot code style: prettier

--- ## Usage and Getting Started To install the package run the following command: ``` npm install @enterprise-cmcs/macpro-serverless-running-stages ``` or ``` yarn add @enterprise-cmcs/macpro-serverless-running-stages ``` After installing the package in your project include this import statement ``` import { ServerlessRunningStages } from "@enterprise-cmcs/macpro-serverless-running-stages"; ``` With ServerlessRunningStages imported you can now execute it like: ``` await ServerlessRunningStages.getAllStagesForRegion("us-east-1"); ``` ## Contributing Found a bug, want to help with updating the docs or maybe you want to help add a feature. Refer to our contribution documentation for more information: [Documentation](./docs/CONTRIBUTING.MD) ## Instructions to test locally with a yarn project - in your terminal from your local clone of macpro-serverless-running-stages with your development branch - `yarn link` (note, when testing is complete, run `yarn unlink`) that will return output like: ``` yarn link v1.22.19 warning ../../../package.json: No license field success Registered "@enterprise-cmcs/macpro-serverless-running-stages". info You can now run `yarn link "@enterprise-cmcs/macpro-serverless-running-stages"` in the projects where you want to use this package and it will be used instead. ✨ Done in 0.06s. ``` - npm install - npm run build (this builds the package) In your local yarn project that will be using the macpro-serverless-running stages package, run: - `rm -rf node_modules` - `yarn link "@enterprise-cmcs/macpro-serverless-running-stages"` that will return output like: ``` yarn link v1.22.19 warning ../../../package.json: No license field success Using linked package for "@enterprise-cmcs/macpro-serverless-running-stages". ✨ Done in 0.05s. ``` - `yarn install` - Note: when testing is complete run `yarn unlink "@enterprise-cmcs/macpro-serverless-running-stages"` ## License [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) See [LICENSE](LICENSE) for full details.