1.0.0 • Published 2 years ago

@tamimi-org/aviation v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

Event API: aviation Data

This CLI tool publishes a stream of real-time aviation Data on predefined destination Solace PubSub+ Broker

How to run

npx @event-api/aviation [OPTIONS]

Below are the following options

FlagDescriptionTypeDefault
-v, --versionoutputs the version number
-h, --hostDestination Solace PubSub+ Broker to publish on websocket port in the form of host:port<host>:<port>ws://localhost:8008
-u, --userDestination Solace PubSub+ Broker username:password<username>:<password>default:default
-m, --msgVPNDestination Solace PubSub+ Broker message VPN<value>default
-d, --documentationLaunch hosted AsyncAPI documentation
--verboseVerbose output logsboolFalse
--no-throttleSkip throttling of publishing to destination broker
--helpdisplay help for command

Development

To run this cli tool locally

  • npm install
  • node index --help

To contribute to this CLI tool

  • Update package.json containing the necessary metadata needed to define the cli tool
    • Update description in package.json
    • Update source_broker in package.json
    • Update asyncAPI documentation in package.json
    • Update version in package.json
  • npm publish --access public

Note: If you dont have access to publish to the @event-api npm registry, contact the admins

To-do

  • Throttle logic in Message callback function of subscriber
    • Message eliding?