Skip to content

Commit

Permalink
address comments
Browse files Browse the repository at this point in the history
Signed-off-by: TJ Zhang <tj.zhang@improving.com>
  • Loading branch information
TJ Zhang committed Aug 28, 2024
1 parent ca65ac3 commit b2c0ae3
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions node/src/BaseClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4660,9 +4660,7 @@ export class BaseClient {
* @param key - The key of the stream.
* @param values - field-value pairs to be added to the entry.
* @param options - options detailing how to add to the stream.
* @param options - (Optional) Additional Parameters:
* - (Optional) `StreamAddOptoins`: options detailing how to add to the stream.
* - (Optional) `decoder`: see {@link DecoderOption}.
* @param options - (Optional) See {@link StreamAddOptions} and {@link DecoderOption}.
* @returns The id of the added entry, or `null` if `options.makeStream` is set to `false` and no stream with the matching `key` exists.
*/
public async xadd(
Expand Down Expand Up @@ -4959,9 +4957,7 @@ export class BaseClient {
* @param consumer - The group consumer.
* @param minIdleTime - The minimum idle time for the message to be claimed.
* @param ids - An array of entry ids.
* @param options - Additional Parameters:
* - (Optional) `StreamAddOptoins`: Stream claim options {@link StreamClaimOptions}.
* - (Optional) `decoder`: see {@link DecoderOption}.
* @param options - (Optional) See {@link StreamClaimOptions} and {@link DecoderOption}.
* @returns A `Record` of message entries that are claimed by the consumer.
*
* @example
Expand Down Expand Up @@ -5146,10 +5142,7 @@ export class BaseClient {
*
* @param key - The key of the stream.
* @param groupName - The newly created consumer group name.
* @param id - Additional Parameters:
* - (Optional) `StreamAddOptoins`: Stream entry ID that specifies the last delivered entry in the stream from the new
* group’s perspective. The special ID `"$"` can be used to specify the last entry in the stream.
* - (Optional) `decoder`: see {@link DecoderOption}.
* @param options - (Optional) See {@link StreamGroupOptions} and {@link DecoderOption}.
* @returns `"OK"`.
*
* @example
Expand Down

0 comments on commit b2c0ae3

Please sign in to comment.