Skip to content

stardew-valley-dedicated-server/asyncapi-generator-template-ts

Repository files navigation

AsyncAPI Generator Template - Typescript

This is a TypeScript Nuxt3 Websocket Messages and Client template for the AsyncAPI generator.

This template is for generating a TypeScript Nuxt3 Websocket Client based on your AsyncAPI 3.0.0 document.

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 in our tests.

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

Requirements

  • @asyncapi/generator >=1.17.25 <2.0.0

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

Template Parameters

These are the available template parameters:

Parameter Type Description
output String The output directory needs to be passed to be passed to the templates. Add the following to the CLI when generating your code -p output=path/to/output.

Features

  • Generates strongly typed message as interfaces.
  • Generates strongly typed client as Nuxt3 composable.

Restrictions

  • Only works in Nuxt3 during client-side rendering

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks