1
0
mirror of https://github.com/redis/node-redis.git synced 2025-07-31 05:44:24 +03:00
Files
node-redis/doctests/dt-tdigest.js
Pavel Pashov 0541b32f34 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>
2025-07-23 18:16:08 +03:00

86 lines
2.0 KiB
JavaScript

// EXAMPLE: tdigest_tutorial
// HIDE_START
import assert from 'assert';
import { createClient } from 'redis';
const client = createClient();
await client.connect();
// HIDE_END
// REMOVE_START
await client.flushDb();
// REMOVE_END
// STEP_START tdig_start
const res1 = await client.tDigest.create('bikes:sales', 100);
console.log(res1); // >>> OK
const res2 = await client.tDigest.add('bikes:sales', [21]);
console.log(res2); // >>> OK
const res3 = await client.tDigest.add('bikes:sales', [150, 95, 75, 34]);
console.log(res3); // >>> OK
// STEP_END
// REMOVE_START
assert.equal(res1, 'OK')
assert.equal(res2, 'OK')
assert.equal(res3, 'OK')
// REMOVE_END
// STEP_START tdig_cdf
const res4 = await client.tDigest.create('racer_ages');
console.log(res4); // >>> OK
const res5 = await client.tDigest.add('racer_ages', [
45.88, 44.2, 58.03, 19.76, 39.84, 69.28, 50.97, 25.41, 19.27, 85.71, 42.63
]);
console.log(res5); // >>> OK
const res6 = await client.tDigest.rank('racer_ages', [50]);
console.log(res6); // >>> [7]
const res7 = await client.tDigest.rank('racer_ages', [50, 40]);
console.log(res7); // >>> [7, 4]
// STEP_END
// REMOVE_START
assert.equal(res4, 'OK')
assert.equal(res5, 'OK')
assert.deepEqual(res6, [7])
assert.deepEqual(res7, [7, 4])
// REMOVE_END
// STEP_START tdig_quant
const res8 = await client.tDigest.quantile('racer_ages', [0.5]);
console.log(res8); // >>> [44.2]
const res9 = await client.tDigest.byRank('racer_ages', [4]);
console.log(res9); // >>> [42.63]
// STEP_END
// STEP_START tdig_min
const res10 = await client.tDigest.min('racer_ages');
console.log(res10); // >>> 19.27
const res11 = await client.tDigest.max('racer_ages');
console.log(res11); // >>> 85.71
// STEP_END
// REMOVE_START
assert.deepEqual(res8, [44.2])
assert.deepEqual(res9, [42.63])
assert.equal(res10, 19.27)
assert.equal(res11, 85.71)
// REMOVE_END
// STEP_START tdig_reset
const res12 = await client.tDigest.reset('racer_ages');
console.log(res12); // >>> OK
// STEP_END
// REMOVE_START
assert.equal(res12, 'OK')
await client.close();
// REMOVE_END