asyncapi / ts-nats-template

Node.js/Typescript template for NATS
Apache License 2.0
21 stars 12 forks source link
asyncapi generator nats nodejs template typescript

TypeScript/Node.js NATS template

All Contributors

This is a TypeScript/Node.js NATS template for the AsyncAPI generator.

This template is for generating a TypeScript/Node.js wrapper for the NATS client based on your AsyncAPI document. The template is based on the nats.js library and can be used as both a TypeScript and Node.js library.

Have you found a bug or have an idea for improvement? Feel free to contribute! See the contribution guidelines for how to do so.

How to use

Example use-cases can be found under examples.

Information about the generated files and a description can be found under the documentation folder.

Requirements

Install the generator through npm or run it from docker official installer.

Template Parameters

These are the available template parameters: Parameter Type Description
generateTestClient Boolean Use this parameter to generate the test client. Add the following to the CLI when generating your code --param "generateTestClient=true"
promisifyReplyCallback Boolean Use this parameter to change from the default regular callback when using the request operation. Add the following to the CLI when generating your code --param "promisifyReplyCallback=true"

Features

Restrictions

Contributing

Before contributing, please read the CONTRIBUTING document.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Jonas Lagoni

🐛 🚧 💻 📖 🤔 💬 ⚠️

Maciej Urbańczyk

👀

Lukasz Gornicki

🚇 👀

Fran Méndez

👀

Colin Sullivan

👀

Alberto Ricart

👀

Alejandra Quetzalli

👀