You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-07-31 05:44:24 +03:00
docs: Update doctests (#3020)
* move all doctests from emb-examples branch * fix readme * add package-lock.json * --wip-- [skip ci] * fix: replace client.quit() with client.close() as quit is deprecated - doctests/cmds-hash.js - doctests/cmds-list.js - doctests/cmds-servermgmt.js - doctests/cmds-set.js * fix: replace client.quit() with client.close() as quit is deprecated - doctests/cmds-sorted-set.js - doctests/cmds-string.js - doctests/dt-bitfield.js - doctests/dt-bitmap.js * fix: replace client.quit() with client.close() as quit is deprecated - dt-bloom.js: replace client.quit() with client.close() - dt-cms.js: replace client.quit() with client.close() - dt-cuckoo.js: replace client.quit() with client.close() and update expected output comments to reflect v5 boolean returns - dt-geo.js: replace client.quit() with client.close() * fix(doctests): correct pfAdd return values and replace quit with close - Fix dt-hll.js: pfAdd returns 1 instead of true in comments and assertions - Fix dt-hash.js and dt-hll.js: replace deprecated client.quit() with client.close() * fix(doctests): correct API usage and return values in json and list examples - Fix dt-json.js: use options object for json.type, json.strLen, json.del, json.arrPop, json.objLen, json.objKeys - Fix dt-json.js: correct json.del return value from [1] to 1 - Fix dt-list.js: correct client initialization, return values (null, OK, 1), and error type - Replace deprecated client.quit() with client.close() in both files * fix(doctests): update dt-set.js and dt-ss.js for v5 compliance - Updated boolean return values to numbers for SISMEMBER and SMISMEMBER commands - Fixed client lifecycle to use client.close() instead of client.quit() - Removed unnecessary await from createClient() - Added order-independent assertions for set operations - Removed debug statement * fix(doctests): update deprecated methods and imports for v5 compliance - Fix dt-string.js: remove await from client creation and replace client.quit() with client.close() - Fix dt-tdigest.js: replace deprecated client.quit() with client.close() - Fix dt-topk.js: replace client.quit() with client.close() and fix output comment from [1, 0] to [true, false] - Fix query-agg.js: update @redis/search imports to use new constant names and replace client.disconnect() with client.close() * fix(doctests): update imports and replace deprecated disconnect with close - Replace SchemaFieldTypes/VectorAlgorithms with SCHEMA_FIELD_TYPE/SCHEMA_VECTOR_FIELD_ALGORITHM - Replace client.disconnect() with client.close() for consistent deprecation handling - Update query-combined.js, query-em.js, query-ft.js, and query-geo.js * fix(doctests): update imports and replace deprecated methods in remaining files - Update imports to use SCHEMA_FIELD_TYPE and SCHEMA_VECTOR_FIELD_ALGORITHM constants - Replace deprecated disconnect() and quit() methods with close() - Fix assertion in search-quickstart.js to use correct bicycle ID * fix(doctests): update cmds-generic.js and cmds-cnxmgmt.js for v5 compliance - Replace deprecated client.quit() with client.close() - Update sScanIterator to use collection-yielding behavior (value -> values) - Fix HSCAN API changes: tuples renamed to entries - Fix cursor type issues: use string '0' instead of number 0 for hScan - Fix infinite loop in scan cleanup by using do-while pattern * fix(doctests): update dt-streams.js object shapes and parameters for v5 compliance - Update stream result objects from tuple format to proper object format with id/message properties - Change xRead/xReadGroup results from nested arrays to objects with name/messages structure - Update xAutoClaim results to use nextId, messages, and deletedMessages properties - Add missing properties to xInfo* results (max-deleted-entry-id, entries-added, recorded-first-entry-id, entries-read, lag, inactive) - Modernize parameter names (count -> COUNT, block -> BLOCK, etc.) - Update MAXLEN/APPROXIMATE options to new TRIM object structure - Fix error message format for XADD duplicate ID error - Update boolean return values (True -> OK) --------- Co-authored-by: Nikolay Karadzhov <nkaradzhov89@gmail.com>
This commit is contained in:
@ -3,7 +3,7 @@ import { RedisArgument, CommandArguments, BlobStringReply, ArrayReply, Command }
|
||||
|
||||
/**
|
||||
* Common options for SCAN-type commands
|
||||
*
|
||||
*
|
||||
* @property MATCH - Pattern to filter returned keys
|
||||
* @property COUNT - Hint for how many elements to return per iteration
|
||||
*/
|
||||
@ -14,7 +14,7 @@ export interface ScanCommonOptions {
|
||||
|
||||
/**
|
||||
* Parses scan arguments for SCAN-type commands
|
||||
*
|
||||
*
|
||||
* @param parser - The command parser
|
||||
* @param cursor - The cursor position for iteration
|
||||
* @param options - Scan options
|
||||
@ -36,7 +36,7 @@ export function parseScanArguments(
|
||||
|
||||
/**
|
||||
* Pushes scan arguments to the command arguments array
|
||||
*
|
||||
*
|
||||
* @param args - The command arguments array
|
||||
* @param cursor - The cursor position for iteration
|
||||
* @param options - Scan options
|
||||
@ -62,7 +62,7 @@ export function pushScanArguments(
|
||||
|
||||
/**
|
||||
* Options for the SCAN command
|
||||
*
|
||||
*
|
||||
* @property TYPE - Filter by value type
|
||||
*/
|
||||
export interface ScanOptions extends ScanCommonOptions {
|
||||
@ -74,7 +74,7 @@ export default {
|
||||
IS_READ_ONLY: true,
|
||||
/**
|
||||
* Constructs the SCAN command
|
||||
*
|
||||
*
|
||||
* @param parser - The command parser
|
||||
* @param cursor - The cursor position to start scanning from
|
||||
* @param options - Scan options
|
||||
@ -87,14 +87,16 @@ export default {
|
||||
if (options?.TYPE) {
|
||||
parser.push('TYPE', options.TYPE);
|
||||
}
|
||||
console.log('eeeeeeeeee', parser.redisArgs)
|
||||
},
|
||||
/**
|
||||
* Transforms the SCAN reply into a structured object
|
||||
*
|
||||
*
|
||||
* @param reply - The raw reply containing cursor and keys
|
||||
* @returns Object with cursor and keys properties
|
||||
*/
|
||||
transformReply([cursor, keys]: [BlobStringReply, ArrayReply<BlobStringReply>]) {
|
||||
console.log(cursor, keys)
|
||||
return {
|
||||
cursor,
|
||||
keys
|
||||
|
Reference in New Issue
Block a user