Skip to content

Commit 8a3e052

Browse files
PavelPashovPavelPashov
authored
feat: add more xtrim method overloads and tests (#2010)
1 parent bf6e89f commit 8a3e052

File tree

2 files changed

+367
-1
lines changed

2 files changed

+367
-1
lines changed

‎lib/utils/RedisCommander.ts‎

Lines changed: 313 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10277,7 +10277,7 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
1027710277
): Result<unknown, Context>;
1027810278

1027910279
/**
10280-
* Trims the stream to (approximately if '~' is passed) a certain size
10280+
* Deletes messages from the beginning of a stream.
1028110281
* - _group_: stream
1028210282
* - _complexity_: O(N), with N being the number of evicted entries. Constant times are very small however, since entries are organized in macro nodes containing multiple entries that can be released with a single deallocation.
1028310283
* - _since_: 5.0.0
@@ -10292,6 +10292,94 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
1029210292
key: RedisKey,
1029310293
maxlen: "MAXLEN",
1029410294
threshold: string | Buffer | number,
10295+
keepref: "KEEPREF",
10296+
callback?: Callback<number>
10297+
): Result<number, Context>;
10298+
xtrim(
10299+
key: RedisKey,
10300+
maxlen: "MAXLEN",
10301+
threshold: string | Buffer | number,
10302+
delref: "DELREF",
10303+
callback?: Callback<number>
10304+
): Result<number, Context>;
10305+
xtrim(
10306+
key: RedisKey,
10307+
maxlen: "MAXLEN",
10308+
threshold: string | Buffer | number,
10309+
acked: "ACKED",
10310+
callback?: Callback<number>
10311+
): Result<number, Context>;
10312+
xtrim(
10313+
key: RedisKey,
10314+
maxlen: "MAXLEN",
10315+
threshold: string | Buffer | number,
10316+
countToken: "LIMIT",
10317+
count: number | string,
10318+
callback?: Callback<number>
10319+
): Result<number, Context>;
10320+
xtrim(
10321+
key: RedisKey,
10322+
maxlen: "MAXLEN",
10323+
threshold: string | Buffer | number,
10324+
countToken: "LIMIT",
10325+
count: number | string,
10326+
keepref: "KEEPREF",
10327+
callback?: Callback<number>
10328+
): Result<number, Context>;
10329+
xtrim(
10330+
key: RedisKey,
10331+
maxlen: "MAXLEN",
10332+
threshold: string | Buffer | number,
10333+
countToken: "LIMIT",
10334+
count: number | string,
10335+
delref: "DELREF",
10336+
callback?: Callback<number>
10337+
): Result<number, Context>;
10338+
xtrim(
10339+
key: RedisKey,
10340+
maxlen: "MAXLEN",
10341+
threshold: string | Buffer | number,
10342+
countToken: "LIMIT",
10343+
count: number | string,
10344+
acked: "ACKED",
10345+
callback?: Callback<number>
10346+
): Result<number, Context>;
10347+
xtrim(
10348+
key: RedisKey,
10349+
maxlen: "MAXLEN",
10350+
equal: "=",
10351+
threshold: string | Buffer | number,
10352+
callback?: Callback<number>
10353+
): Result<number, Context>;
10354+
xtrim(
10355+
key: RedisKey,
10356+
maxlen: "MAXLEN",
10357+
equal: "=",
10358+
threshold: string | Buffer | number,
10359+
keepref: "KEEPREF",
10360+
callback?: Callback<number>
10361+
): Result<number, Context>;
10362+
xtrim(
10363+
key: RedisKey,
10364+
maxlen: "MAXLEN",
10365+
equal: "=",
10366+
threshold: string | Buffer | number,
10367+
delref: "DELREF",
10368+
callback?: Callback<number>
10369+
): Result<number, Context>;
10370+
xtrim(
10371+
key: RedisKey,
10372+
maxlen: "MAXLEN",
10373+
equal: "=",
10374+
threshold: string | Buffer | number,
10375+
acked: "ACKED",
10376+
callback?: Callback<number>
10377+
): Result<number, Context>;
10378+
xtrim(
10379+
key: RedisKey,
10380+
maxlen: "MAXLEN",
10381+
equal: "=",
10382+
threshold: string | Buffer | number,
1029510383
countToken: "LIMIT",
1029610384
count: number | string,
1029710385
callback?: Callback<number>
@@ -10301,6 +10389,9 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
1030110389
maxlen: "MAXLEN",
1030210390
equal: "=",
1030310391
threshold: string | Buffer | number,
10392+
countToken: "LIMIT",
10393+
count: number | string,
10394+
keepref: "KEEPREF",
1030410395
callback?: Callback<number>
1030510396
): Result<number, Context>;
1030610397
xtrim(
@@ -10310,13 +10401,77 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
1031010401
threshold: string | Buffer | number,
1031110402
countToken: "LIMIT",
1031210403
count: number | string,
10404+
delref: "DELREF",
10405+
callback?: Callback<number>
10406+
): Result<number, Context>;
10407+
xtrim(
10408+
key: RedisKey,
10409+
maxlen: "MAXLEN",
10410+
equal: "=",
10411+
threshold: string | Buffer | number,
10412+
countToken: "LIMIT",
10413+
count: number | string,
10414+
acked: "ACKED",
10415+
callback?: Callback<number>
10416+
): Result<number, Context>;
10417+
xtrim(
10418+
key: RedisKey,
10419+
maxlen: "MAXLEN",
10420+
approximately: "~",
10421+
threshold: string | Buffer | number,
10422+
callback?: Callback<number>
10423+
): Result<number, Context>;
10424+
xtrim(
10425+
key: RedisKey,
10426+
maxlen: "MAXLEN",
10427+
approximately: "~",
10428+
threshold: string | Buffer | number,
10429+
keepref: "KEEPREF",
1031310430
callback?: Callback<number>
1031410431
): Result<number, Context>;
1031510432
xtrim(
1031610433
key: RedisKey,
1031710434
maxlen: "MAXLEN",
1031810435
approximately: "~",
1031910436
threshold: string | Buffer | number,
10437+
delref: "DELREF",
10438+
callback?: Callback<number>
10439+
): Result<number, Context>;
10440+
xtrim(
10441+
key: RedisKey,
10442+
maxlen: "MAXLEN",
10443+
approximately: "~",
10444+
threshold: string | Buffer | number,
10445+
acked: "ACKED",
10446+
callback?: Callback<number>
10447+
): Result<number, Context>;
10448+
xtrim(
10449+
key: RedisKey,
10450+
maxlen: "MAXLEN",
10451+
approximately: "~",
10452+
threshold: string | Buffer | number,
10453+
countToken: "LIMIT",
10454+
count: number | string,
10455+
callback?: Callback<number>
10456+
): Result<number, Context>;
10457+
xtrim(
10458+
key: RedisKey,
10459+
maxlen: "MAXLEN",
10460+
approximately: "~",
10461+
threshold: string | Buffer | number,
10462+
countToken: "LIMIT",
10463+
count: number | string,
10464+
keepref: "KEEPREF",
10465+
callback?: Callback<number>
10466+
): Result<number, Context>;
10467+
xtrim(
10468+
key: RedisKey,
10469+
maxlen: "MAXLEN",
10470+
approximately: "~",
10471+
threshold: string | Buffer | number,
10472+
countToken: "LIMIT",
10473+
count: number | string,
10474+
delref: "DELREF",
1032010475
callback?: Callback<number>
1032110476
): Result<number, Context>;
1032210477
xtrim(
@@ -10326,6 +10481,7 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
1032610481
threshold: string | Buffer | number,
1032710482
countToken: "LIMIT",
1032810483
count: number | string,
10484+
acked: "ACKED",
1032910485
callback?: Callback<number>
1033010486
): Result<number, Context>;
1033110487
xtrim(
@@ -10338,6 +10494,94 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
1033810494
key: RedisKey,
1033910495
minid: "MINID",
1034010496
threshold: string | Buffer | number,
10497+
keepref: "KEEPREF",
10498+
callback?: Callback<number>
10499+
): Result<number, Context>;
10500+
xtrim(
10501+
key: RedisKey,
10502+
minid: "MINID",
10503+
threshold: string | Buffer | number,
10504+
delref: "DELREF",
10505+
callback?: Callback<number>
10506+
): Result<number, Context>;
10507+
xtrim(
10508+
key: RedisKey,
10509+
minid: "MINID",
10510+
threshold: string | Buffer | number,
10511+
acked: "ACKED",
10512+
callback?: Callback<number>
10513+
): Result<number, Context>;
10514+
xtrim(
10515+
key: RedisKey,
10516+
minid: "MINID",
10517+
threshold: string | Buffer | number,
10518+
countToken: "LIMIT",
10519+
count: number | string,
10520+
callback?: Callback<number>
10521+
): Result<number, Context>;
10522+
xtrim(
10523+
key: RedisKey,
10524+
minid: "MINID",
10525+
threshold: string | Buffer | number,
10526+
countToken: "LIMIT",
10527+
count: number | string,
10528+
keepref: "KEEPREF",
10529+
callback?: Callback<number>
10530+
): Result<number, Context>;
10531+
xtrim(
10532+
key: RedisKey,
10533+
minid: "MINID",
10534+
threshold: string | Buffer | number,
10535+
countToken: "LIMIT",
10536+
count: number | string,
10537+
delref: "DELREF",
10538+
callback?: Callback<number>
10539+
): Result<number, Context>;
10540+
xtrim(
10541+
key: RedisKey,
10542+
minid: "MINID",
10543+
threshold: string | Buffer | number,
10544+
countToken: "LIMIT",
10545+
count: number | string,
10546+
acked: "ACKED",
10547+
callback?: Callback<number>
10548+
): Result<number, Context>;
10549+
xtrim(
10550+
key: RedisKey,
10551+
minid: "MINID",
10552+
equal: "=",
10553+
threshold: string | Buffer | number,
10554+
callback?: Callback<number>
10555+
): Result<number, Context>;
10556+
xtrim(
10557+
key: RedisKey,
10558+
minid: "MINID",
10559+
equal: "=",
10560+
threshold: string | Buffer | number,
10561+
keepref: "KEEPREF",
10562+
callback?: Callback<number>
10563+
): Result<number, Context>;
10564+
xtrim(
10565+
key: RedisKey,
10566+
minid: "MINID",
10567+
equal: "=",
10568+
threshold: string | Buffer | number,
10569+
delref: "DELREF",
10570+
callback?: Callback<number>
10571+
): Result<number, Context>;
10572+
xtrim(
10573+
key: RedisKey,
10574+
minid: "MINID",
10575+
equal: "=",
10576+
threshold: string | Buffer | number,
10577+
acked: "ACKED",
10578+
callback?: Callback<number>
10579+
): Result<number, Context>;
10580+
xtrim(
10581+
key: RedisKey,
10582+
minid: "MINID",
10583+
equal: "=",
10584+
threshold: string | Buffer | number,
1034110585
countToken: "LIMIT",
1034210586
count: number | string,
1034310587
callback?: Callback<number>
@@ -10347,6 +10591,9 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
1034710591
minid: "MINID",
1034810592
equal: "=",
1034910593
threshold: string | Buffer | number,
10594+
countToken: "LIMIT",
10595+
count: number | string,
10596+
keepref: "KEEPREF",
1035010597
callback?: Callback<number>
1035110598
): Result<number, Context>;
1035210599
xtrim(
@@ -10356,13 +10603,77 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
1035610603
threshold: string | Buffer | number,
1035710604
countToken: "LIMIT",
1035810605
count: number | string,
10606+
delref: "DELREF",
10607+
callback?: Callback<number>
10608+
): Result<number, Context>;
10609+
xtrim(
10610+
key: RedisKey,
10611+
minid: "MINID",
10612+
equal: "=",
10613+
threshold: string | Buffer | number,
10614+
countToken: "LIMIT",
10615+
count: number | string,
10616+
acked: "ACKED",
10617+
callback?: Callback<number>
10618+
): Result<number, Context>;
10619+
xtrim(
10620+
key: RedisKey,
10621+
minid: "MINID",
10622+
approximately: "~",
10623+
threshold: string | Buffer | number,
10624+
callback?: Callback<number>
10625+
): Result<number, Context>;
10626+
xtrim(
10627+
key: RedisKey,
10628+
minid: "MINID",
10629+
approximately: "~",
10630+
threshold: string | Buffer | number,
10631+
keepref: "KEEPREF",
1035910632
callback?: Callback<number>
1036010633
): Result<number, Context>;
1036110634
xtrim(
1036210635
key: RedisKey,
1036310636
minid: "MINID",
1036410637
approximately: "~",
1036510638
threshold: string | Buffer | number,
10639+
delref: "DELREF",
10640+
callback?: Callback<number>
10641+
): Result<number, Context>;
10642+
xtrim(
10643+
key: RedisKey,
10644+
minid: "MINID",
10645+
approximately: "~",
10646+
threshold: string | Buffer | number,
10647+
acked: "ACKED",
10648+
callback?: Callback<number>
10649+
): Result<number, Context>;
10650+
xtrim(
10651+
key: RedisKey,
10652+
minid: "MINID",
10653+
approximately: "~",
10654+
threshold: string | Buffer | number,
10655+
countToken: "LIMIT",
10656+
count: number | string,
10657+
callback?: Callback<number>
10658+
): Result<number, Context>;
10659+
xtrim(
10660+
key: RedisKey,
10661+
minid: "MINID",
10662+
approximately: "~",
10663+
threshold: string | Buffer | number,
10664+
countToken: "LIMIT",
10665+
count: number | string,
10666+
keepref: "KEEPREF",
10667+
callback?: Callback<number>
10668+
): Result<number, Context>;
10669+
xtrim(
10670+
key: RedisKey,
10671+
minid: "MINID",
10672+
approximately: "~",
10673+
threshold: string | Buffer | number,
10674+
countToken: "LIMIT",
10675+
count: number | string,
10676+
delref: "DELREF",
1036610677
callback?: Callback<number>
1036710678
): Result<number, Context>;
1036810679
xtrim(
@@ -10372,6 +10683,7 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
1037210683
threshold: string | Buffer | number,
1037310684
countToken: "LIMIT",
1037410685
count: number | string,
10686+
acked: "ACKED",
1037510687
callback?: Callback<number>
1037610688
): Result<number, Context>;
1037710689

0 commit comments

Comments
 (0)