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.

Sign up for GitHub

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

Java/Node: Update docs for xadd and xtrim #186

Merged
merged 1 commit into from
Apr 8, 2024
Merged

Java/Node: Update docs for xadd and xtrim #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions java/client/src/main/java/glide/api/commands/StreamBaseCommands.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
public interface StreamBaseCommands {

/**
* Adds an entry to the specified stream.
* Adds an entry to the specified stream stored at <code>key</code>.<br>
* If the <code>key</code> doesn't exist, the stream is created.
*
* @see <a href="https://redis.io/commands/xadd/">redis.io</a> for details.
* @param key The key of the stream.
Expand All @@ -29,7 +30,8 @@ public interface StreamBaseCommands {
CompletableFuture<String> xadd(String key, Map<String, String> values);

/**
* Adds an entry to the specified stream.
* Adds an entry to the specified stream stored at <code>key</code>.<br>
* If the <code>key</code> doesn't exist, the stream is created.
*
* @see <a href="https://redis.io/commands/xadd/">redis.io</a> for details.
* @param key The key of the stream.
Expand Down
6 changes: 4 additions & 2 deletions java/client/src/main/java/glide/api/models/BaseTransaction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1332,7 +1332,8 @@ public T zscore(@NonNull String key, @NonNull String member) {
}

/**
* Adds an entry to the specified stream.
* Adds an entry to the specified stream stored at <code>key</code>.<br>
* If the <code>key</code> doesn't exist, the stream is created.
*
* @see <a href="https://redis.io/commands/xadd/">redis.io</a> for details.
* @param key The key of the stream.
Expand All @@ -1345,7 +1346,8 @@ public T xadd(@NonNull String key, @NonNull Map<String, String> values) {
}

/**
* Adds an entry to the specified stream.
* Adds an entry to the specified stream stored at <code>key</code>.<br>
* If the <code>key</code> doesn't exist, the stream is created.
*
* @see <a href="https://redis.io/commands/xadd/">redis.io</a> for details.
* @param key The key of the stream.
Expand Down
4 changes: 2 additions & 2 deletions node/src/BaseClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1273,7 +1273,7 @@ export class BaseClient {
}

/**
* Adds an entry to the specified stream.
* Adds an entry to the specified stream stored at `key`. If the `key` doesn't exist, the stream is created.
* See https://redis.io/commands/xadd/ for more details.
*
* @param key - The key of the stream.
Expand All @@ -1289,7 +1289,7 @@ export class BaseClient {
}

/**
* Trims the stream by evicting older entries.
* Trims the stream stored at `key` by evicting older entries.
* See https://redis.io/commands/xtrim/ for more details.
*
* @param key - the key of the stream
Expand Down
4 changes: 2 additions & 2 deletions node/src/Transaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1090,7 +1090,7 @@ export class BaseTransaction<T extends BaseTransaction<T>> {
}

/**
* Adds an entry to the specified stream.
* Adds an entry to the specified stream stored at `key`. If the `key` doesn't exist, the stream is created.
* See https://redis.io/commands/xadd/ for more details.
*
* @param key - The key of the stream.
Expand All @@ -1106,7 +1106,7 @@ export class BaseTransaction<T extends BaseTransaction<T>> {
}

/**
* Trims the stream by evicting older entries.
* Trims the stream stored at `key` by evicting older entries.
* See https://redis.io/commands/xtrim/ for more details.
*
* @param key - the key of the stream
Expand Down
Loading