camunda-community-hub / zeebe-client-node-js

Node.js client library for Zeebe Microservices Orchestration Engine
https://camunda-community-hub.github.io/zeebe-client-node-js/
Apache License 2.0
152 stars 38 forks source link

timeToLive documentation fix #311

Closed nhomble closed 1 year ago

nhomble commented 1 year ago

Issue tracker is ONLY used for reporting bugs. New features and questions should be discussed on our slack channel.

Expected Behavior

In the library docs, timeToLive in the message publisher states

    /** The number of seconds for the message to buffer on the broker, awaiting correlation. Omit or set to zero for no buffering. */
    timeToLive: MaybeTimeDuration;

so I was expecting the argument to be optional (and defaulted to 0)

Current Behavior

There is a ts-compiler error because the argument is required.

Possible Solution

Add a ?