https://github.com/getlarge/nestjs-tools

Open-source libraries for NestJS framework
https://github.com/getlarge/nestjs-tools

async-local-storage cluster lock microservices nestjs rabbitmq typescript

Last synced: 4 days ago
JSON representation

Open-source libraries for NestJS framework

• Host: GitHub
• URL: https://github.com/getlarge/nestjs-tools
• Owner: getlarge
• License: apache-2.0
• Created: 2022-03-15T04:22:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-19T16:46:43.000Z (13 days ago)
• Last Synced: 2024-09-25T01:04:26.994Z (7 days ago)
• Topics: async-local-storage, cluster, lock, microservices, nestjs, rabbitmq, typescript
• Language: TypeScript
• Homepage:
• Size: 2.68 MB
• Stars: 43
• Watchers: 4
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Audit: audit-ci.json

Awesome Lists containing this project

README

        


  



# NestJS Tools

[![License: Apache 2.0](https://img.shields.io/badge/License-Apache-yellow.svg)](https://opensource.org/license/apache-2-0)

[![CI](https://github.com/getlarge/nestjs-tools/actions/workflows/node.yml/badge.svg)](https://github.com/getlarge/nestjs-tools/actions/workflows/node.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=getlarge_nestjs-tools&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=getlarge_nestjs-tools)

[![code style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

This repository contains several helpful packages for NestJS that I have developed for NestJS applications running in production.

## List of packages

| Package                                                         | Description                                                          | Version                                                                                                                                                            |

| --------------------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

| [AMQP-Transport](./packages/amqp-transport/README.md)           | A NestJS microservice adapter around [AMQPlib] supporting exchanges. | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-amqp-transport.svg?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-amqp-transport)       |

| [Async-Local-Storage](./packages/async-local-storage/README.md) | A NestJS module to track context with [AsyncLocalStorage].           | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-async-local-storage?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-async-local-storage) |

| [Cluster](./packages/cluster/README.md)                         | A class to manage workers' lifecycle in a (Node.js) [cluster].       | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-cluster?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-cluster)                         |

| [ESLint-Plugin](./packages/eslint-plugin/README.md)             | A set of ESLint rules for NestJS applications.                       | [![npm](https://img.shields.io/npm/v/@getlarge/eslint-plugin-nestjs-tools?style=flat)](https://npmjs.org/package/@getlarge/eslint-plugin-nestjs-tools)             |

| [File-Storage](./packages/file-storage/README.md)               | A NestJS module supporting [FS], [S3] and [GCP] strategies.          | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-file-storage?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-file-storage)               |

| [Lock](./packages/lock/README.md)                               | A NestJS module to provide a distributed lock for your application.  | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-lock?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-lock)                               |

| [Fastify-Upload](./packages/fastify-upload/README.md)           | A NestJS module to provide file upload support for Fastify.          | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-fastify-upload?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-fastify-upload)           |

## Installation and usage

Check the README of each package for more details.

## Examples

Check out the following projects for examples of using these packages:

- The [ticketing repository](https://github.com/getlarge/ticketing) is a real-world example of AMQP-Transport, File-Storage, Lock

- The [cat fostering repository](https://github.com/getlarge/catfostering) uses Fastify-Upload

[AMQPlib]: https://amqp-node.github.io/amqplib/

[AsyncLocalStorage]: https://nodejs.org/api/async_context.html#class-asynclocalstorage

[cluster]: https://nodejs.org/api/cluster.html

[FS]: https://nodejs.org/api/fs.html

[S3]: https://aws.amazon.com/s3/

[GCP]: https://cloud.google.com/storage