Skip to content

Fix typo and improve Sentinel docs #2931

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

Merged
merged 1 commit into from
Apr 30, 2025

Conversation

bobymicroby
Copy link
Member

No description provided.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR addresses a typo in method naming and improves documentation for the Sentinel client, clarifying configuration options and client lease management.

  • Fixes the incorrect method name "aquire" by renaming it to "acquire".
  • Enhances comments and JSDoc for better clarity on client lease operations and sentinel configuration settings.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
packages/client/lib/sentinel/types.ts Improved documentation on scanInterval and passthroughClientErrorEvents options.
packages/client/lib/sentinel/index.ts Added new getters and methods (acquire, release) with detailed JSDoc comments.
packages/client/lib/sentinel/index.spec.ts Updated tests to use the corrected acquire method.
docs/sentinel.md Updated documentation samples and configuration table to reflect accurate method names and descriptions.
Comments suppressed due to low confidence (1)

packages/client/lib/sentinel/index.ts:252

  • [nitpick] Consider including an identifier or additional context in the error message to help track which client lease was attempted to be released multiple times.
throw new Error('RedisSentinelClient lease already released');

@bobymicroby bobymicroby merged commit 46bfeaa into redis:master Apr 30, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants