Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing timeout property to type. #77

Merged
merged 3 commits into from
May 8, 2024
Merged

Conversation

ramhr
Copy link
Contributor

@ramhr ramhr commented May 8, 2024

No description provided.

@ramhr ramhr requested review from shamil and yosiat as code owners May 8, 2024 09:48
@@ -10,6 +10,8 @@ declare class ProducerError extends Error {
interface ProduceOptions extends amqp.Options.Publish {
routingKey?: string;
rpc?: boolean;
/** Timeout in milliseconds for producing RPC request and waiting for the response. Does not affect non-rpc requests. */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/** Timeout in milliseconds for producing RPC request and waiting for the response. Does not affect non-rpc requests. */
// Timeout in milliseconds for producing RPC request and waiting for the response. Does not affect non-rpc requests.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why comment needed, specifically for this field?
I suggest either document all properties, or none. Lets be consistent.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The options are not intuitive, so I added docs to all of them.

@yosiat yosiat removed their assignment May 8, 2024
@@ -10,6 +10,8 @@ declare class ProducerError extends Error {
interface ProduceOptions extends amqp.Options.Publish {
routingKey?: string;
rpc?: boolean;
/** Timeout in milliseconds for producing RPC request and waiting for the response. Does not affect non-rpc requests. */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why comment needed, specifically for this field?
I suggest either document all properties, or none. Lets be consistent.

@shamil shamil assigned ramhr and unassigned shamil May 8, 2024
@ramhr ramhr force-pushed the add_timeout_property_to_type branch from 2662e2a to 81b7bbf Compare May 8, 2024 12:02
@ramhr ramhr assigned shamil and unassigned ramhr May 8, 2024
@shamil shamil assigned ramhr and unassigned shamil May 8, 2024
@ramhr ramhr merged commit 6a94f64 into master May 8, 2024
4 checks passed
@ramhr ramhr deleted the add_timeout_property_to_type branch May 8, 2024 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants