-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
expressions.d.ts
2901 lines (2655 loc) · 109 KB
/
expressions.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
declare module 'mongoose' {
/**
* [Expressions reference](https://docs.mongodb.com/manual/meta/aggregation-quick-reference/#expressions)
*/
type AggregationVariables =
SpecialPathVariables |
'$$NOW' |
'$$CLUSTER_TIME' |
'$$DESCEND' |
'$$PRUNE' |
'$$KEEP';
type SpecialPathVariables =
'$$ROOT' |
'$$CURRENT' |
'$$REMOVE';
export namespace Expression {
export interface Abs {
/**
* Returns the absolute value of a number.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/abs/#mongodb-expression-exp.-abs
*/
$abs: Path | ArithmeticExpressionOperator;
}
export interface Add {
/**
* Adds numbers to return the sum, or adds numbers and a date to return a new date. If adding numbers and a date, treats the numbers as milliseconds. Accepts any number of argument expressions, but at most, one expression can resolve to a date.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/add/#mongodb-expression-exp.-add
*/
$add: (NumberExpression | DateExpression)[];
}
export interface Ceil {
/**
* Returns the smallest integer greater than or equal to the specified number.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/ceil/#mongodb-expression-exp.-ceil
*/
$ceil: NumberExpression;
}
export interface Divide {
/**
* Returns the result of dividing the first number by the second. Accepts two argument expressions.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/divide/#mongodb-expression-exp.-divide
*/
$divide: NumberExpression[];
}
export interface Exp {
/**
* Raises e to the specified exponent.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/exp/#mongodb-expression-exp.-exp
*/
$exp: NumberExpression;
}
export interface Floor {
/**
* Returns the largest integer less than or equal to the specified number.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/floor/#mongodb-expression-exp.-floor
*/
$floor: NumberExpression;
}
export interface Ln {
/**
* Calculates the natural log of a number.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/ln/#mongodb-expression-exp.-ln
*/
$ln: NumberExpression;
}
export interface Log {
/**
* Calculates the log of a number in the specified base.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/log/#mongodb-expression-exp.-log
*/
$log: [NumberExpression, NumberExpression];
}
export interface Log10 {
/**
* Calculates the log base 10 of a number.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/log10/#mongodb-expression-exp.-log10
*/
$log10: NumberExpression;
}
export interface Mod {
/**
* Returns the remainder of the first number divided by the second. Accepts two argument expressions.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/mod/#mongodb-expression-exp.-mod
*/
$mod: [NumberExpression, NumberExpression];
}
export interface Multiply {
/**
* Multiplies numbers to return the product. Accepts any number of argument expressions.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/multiply/#mongodb-expression-exp.-multiply
*/
$multiply: NumberExpression[];
}
export interface Pow {
/**
* Raises a number to the specified exponent.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/pow/#mongodb-expression-exp.-pow
*/
$pow: [NumberExpression, NumberExpression];
}
export interface Round {
/**
* Rounds a number to to a whole integer or to a specified decimal place.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/round/#mongodb-expression-exp.-round
*/
$round: [NumberExpression, NumberExpression?];
}
export interface Sqrt {
/**
* Calculates the square root.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/sqrt/#mongodb-expression-exp.-sqrt
*/
$sqrt: NumberExpression;
}
export interface Subtract {
/**
* Returns the result of subtracting the second value from the first. If the two values are numbers, return the difference. If the two values are dates, return the difference in milliseconds. If the two values are a date and a number in milliseconds, return the resulting date. Accepts two argument expressions. If the two values are a date and a number, specify the date argument first as it is not meaningful to subtract a date from a number.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/subtract/#mongodb-expression-exp.-subtract
*/
$subtract: (NumberExpression | DateExpression)[];
}
export interface Trunc {
/**
* Truncates a number to a whole integer or to a specified decimal place.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/trunc/#mongodb-expression-exp.-trunc
*/
$trunc: [NumberExpression, NumberExpression?];
}
export interface Sin {
/**
* Returns the sine of a value that is measured in radians.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/sin/#mongodb-expression-exp.-sin
*/
$sin: NumberExpression;
}
export interface Cos {
/**
* Returns the cosine of a value that is measured in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/cos/#mongodb-expression-exp.-cos
*/
$cos: NumberExpression;
}
export interface Tan {
/**
* Returns the tangent of a value that is measured in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/tan/#mongodb-expression-exp.-tan
*/
$tan: NumberExpression;
}
export interface Asin {
/**
* Returns the inverse sin (arc sine) of a value in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/asin/#mongodb-expression-exp.-asin
*/
$asin: NumberExpression;
}
export interface Acos {
/**
* Returns the inverse cosine (arc cosine) of a value in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/acos/#mongodb-expression-exp.-acos
*/
$acos: NumberExpression;
}
export interface Atan {
/**
* Returns the inverse tangent (arc tangent) of a value in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/atan/#mongodb-expression-exp.-atan
*/
$atan: NumberExpression;
}
export interface Atan2 {
/**
* Returns the inverse tangent (arc tangent) of y / x in radians, where y and x are the first and second values passed to the expression respectively.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/atan2/#mongodb-expression-exp.-atan2
*/
$atan2: NumberExpression;
}
export interface Asinh {
/**
* Returns the inverse hyperbolic sine (hyperbolic arc sine) of a value in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/asinh/#mongodb-expression-exp.-asinh
*/
$asinh: NumberExpression;
}
export interface Acosh {
/**
* Returns the inverse hyperbolic cosine (hyperbolic arc cosine) of a value in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/acosh/#mongodb-expression-exp.-acosh
*/
$acosh: NumberExpression;
}
export interface Atanh {
/**
* Returns the inverse hyperbolic tangent (hyperbolic arc tangent) of a value in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/atanh/#mongodb-expression-exp.-atanh
*/
$atanh: NumberExpression;
}
export interface Sinh {
/**
* Returns the hyperbolic sine of a value that is measured in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/sinh/#mongodb-expression-exp.-sinh
*/
$sinh: NumberExpression;
}
export interface Cosh {
/**
* Returns the hyperbolic cosine of a value that is measured in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/cosh/#mongodb-expression-exp.-cosh
*/
$cosh: NumberExpression;
}
export interface Tanh {
/**
* Returns the hyperbolic tangent of a value that is measured in radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/tanh/#mongodb-expression-exp.-tanh
*/
$tanh: NumberExpression;
}
export interface DegreesToRadians {
/**
* Converts a value from degrees to radians.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/degreesToRadians/#mongodb-expression-exp.-degreesToRadians
*/
$degreesToRadians: NumberExpression;
}
export interface RadiansToDegrees {
/**
* Converts a value from radians to degrees.
*
* @version 4.2
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/radiansToDegrees/#mongodb-expression-exp.-radiansToDegrees
*/
$radiansToDegrees: NumberExpression;
}
export interface Meta {
/**
* Access available per-document metadata related to the aggregation operation.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/meta/#mongodb-expression-exp.-meta
*/
$meta: 'textScore' | 'indexKey';
}
export interface DateAdd {
/**
* Adds a number of time units to a date object.
*
* @version 5.0.0
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dateAdd/#mongodb-expression-exp.-dateAdd
*/
$dateAdd: {
/**
* The beginning date, in UTC, for the addition operation. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
startDate: DateExpression;
/**
* The unit used to measure the amount of time added to the startDate. The unit is an expression that resolves to one of the following strings:
* - year
* - quarter
* - week
* - month
* - day
* - hour
* - minute
* - second
* - millisecond
*/
unit: StringExpression<DateUnit>;
/**
* The number of units added to the startDate. The amount is an expression that resolves to an integer or long. The amount can also resolve to an integral decimal or a double if that value can be converted to a long without loss of precision.
*/
amount: NumberExpression;
/**
* The timezone to carry out the operation. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface DateDiff {
/**
* Returns the difference between two dates.
*
* @version 5.0
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dateDiff/#mongodb-expression-exp.-dateDiff
*/
$dateDiff: {
/**
* The start of the time period. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
startDate: DateExpression;
/**
* The end of the time period. The endDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
endDate: DateExpression;
/**
* The time measurement unit between the startDate and endDate. It is an expression that resolves to a string:
* - year
* - quarter
* - week
* - month
* - day
* - hour
* - minute
* - second
* - millisecond
*/
unit: StringExpression<DateUnit>;
/**
* The timezone to carry out the operation. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
/**
* Used when the unit is equal to week. Defaults to Sunday. The startOfWeek parameter is an expression that resolves to a case insensitive string:
* - monday (or mon)
* - tuesday (or tue)
* - wednesday (or wed)
* - thursday (or thu)
* - friday (or fri)
* - saturday (or sat)
* - sunday (or sun)
*/
startOfWeek?: StringExpression<StartOfWeek>;
}
}
// TODO: Can be done better
export interface DateFromParts {
/**
* Constructs a BSON Date object given the date's constituent parts.
*
* @version 3.6
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dateFromParts/#mongodb-expression-exp.-dateFromParts
*/
$dateFromParts: {
/**
* ISO Week Date Year. Can be any expression that evaluates to a number.
*
* Value range: 1-9999
*
* If the number specified is outside this range, $dateFromParts errors. Starting in MongoDB 4.4, the lower bound for this value is 1. In previous versions of MongoDB, the lower bound was 0.
*/
isoWeekYear?: NumberExpression;
/**
* Week of year. Can be any expression that evaluates to a number.
*
* Defaults to 1.
*
* Value range: 1-53
*
* Starting in MongoDB 4.0, if the number specified is outside this range, $dateFromParts incorporates the difference in the date calculation. See Value Range for examples.
*/
isoWeek?: NumberExpression;
/**
* Day of week (Monday 1 - Sunday 7). Can be any expression that evaluates to a number.
*
* Defaults to 1.
*
* Value range: 1-7
*
* Starting in MongoDB 4.0, if the number specified is outside this range, $dateFromParts incorporates the difference in the date calculation. See Value Range for examples.
*/
isoDayOfWeek?: NumberExpression;
/**
* Calendar year. Can be any expression that evaluates to a number.
*
* Value range: 1-9999
*
* If the number specified is outside this range, $dateFromParts errors. Starting in MongoDB 4.4, the lower bound for this value is 1. In previous versions of MongoDB, the lower bound was 0.
*/
year?: NumberExpression;
/**
* Month. Can be any expression that evaluates to a number.
*
* Defaults to 1.
*
* Value range: 1-12
*
* Starting in MongoDB 4.0, if the number specified is outside this range, $dateFromParts incorporates the difference in the date calculation. See Value Range for examples.
*/
month?: NumberExpression;
/**
* Day of month. Can be any expression that evaluates to a number.
*
* Defaults to 1.
*
* Value range: 1-31
*
* Starting in MongoDB 4.0, if the number specified is outside this range, $dateFromParts incorporates the difference in the date calculation. See Value Range for examples.
*/
day?: NumberExpression;
/**
* Hour. Can be any expression that evaluates to a number.
*
* Defaults to 0.
*
* Value range: 0-23
*
* Starting in MongoDB 4.0, if the number specified is outside this range, $dateFromParts incorporates the difference in the date calculation. See Value Range for examples.
*/
hour?: NumberExpression;
/**
* Minute. Can be any expression that evaluates to a number.
*
* Defaults to 0.
*
* Value range: 0-59 Starting in MongoDB 4.0, if the number specified is outside this range, $dateFromParts incorporates the difference in the date calculation. See Value Range for examples.
*/
minute?: NumberExpression;
/**
* Second. Can be any expression that evaluates to a number.
*
* Defaults to 0.
*
* Value range: 0-59
*
* Starting in MongoDB 4.0, if the number specified is outside this range, $dateFromParts incorporates the difference in the date calculation. See Value Range for examples.
*/
second?: NumberExpression;
/**
* Millisecond. Can be any expression that evaluates to a number.
*
* Defaults to 0.
*
* Value range: 0-999
*
* Starting in MongoDB 4.0, if the number specified is outside this range, $dateFromParts incorporates the difference in the date calculation. See Value Range for examples.
*/
millisecond?: NumberExpression;
/**
* The timezone to carry out the operation. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface DateFromString {
/**
* Converts a date/time string to a date object.
*
* @version 3.6
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dateFromString/#mongodb-expression-exp.-dateFromString
*/
$dateFromString: {
dateString: StringExpression<string>;
/**
* The date format specification of the dateString. The format can be any expression that evaluates to a string literal, containing 0 or more format specifiers. For a list of specifiers available, see Format Specifiers.
*
* If unspecified, $dateFromString uses "%Y-%m-%dT%H:%M:%S.%LZ" as the default format.
* @version 4.0
*/
format?: FormatString;
/**
* The time zone to use to format the date.
*
* Note: If the dateString argument is formatted like '2017-02-08T12:10:40.787Z', in which the 'Z' at the end indicates Zulu time (UTC time zone), you cannot specify the timezone argument.
*/
timezone?: tzExpression;
/**
* Optional. If $dateFromString encounters an error while parsing the given dateString, it outputs the result value of the provided onError expression. This result value can be of any type.
*
* If you do not specify onError, $dateFromString throws an error if it cannot parse dateString.
*/
onError?: Expression;
/**
* Optional. If the dateString provided to $dateFromString is null or missing, it outputs the result value of the provided onNull expression. This result value can be of any type.
*
* If you do not specify onNull and dateString is null or missing, then $dateFromString outputs null.
*/
onNull?: Expression;
};
}
export interface DateSubtract {
/**
* Subtracts a number of time units from a date object.
*
* @version 5.0
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dateSubtract/#mongodb-expression-exp.-dateSubtract
*/
$dateSubtract: {
/**
* The beginning date, in UTC, for the subtraction operation. The startDate can be any expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
startDate: DateExpression;
/**
* The unit of time, specified as an expression that must resolve to one of these strings:
* - year
* - quarter
* - week
* - month
* - day
* - hour
* - minute
* - second
* - millisecond
*
* Together, binSize and unit specify the time period used in the $dateTrunc calculation.
*/
unit: StringExpression<DateUnit>;
/**
* The number of units subtracted from the startDate. The amount is an expression that resolves to an integer or long. The amount can also resolve to an integral decimal and or a double if that value can be converted to a long without loss of precision.
*/
amount: NumberExpression;
/**
* The timezone to carry out the operation. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface DateToParts {
/**
* Returns a document containing the constituent parts of a date.
*
* @version 3.6
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dateToParts/#mongodb-expression-exp.-dateToParts
*/
$dateToParts: {
/**
* The input date for which to return parts. <dateExpression> can be any expression that resolves to a Date, a Timestamp, or an ObjectID. For more information on expressions, see Expressions.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*
* @version 3.6
*/
timezone?: tzExpression;
/**
* If set to true, modifies the output document to use ISO week date fields. Defaults to false.
*/
iso8601?: boolean;
};
}
export interface DateToString {
/**
* Returns the date as a formatted string.
*
* @version 3.6
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dateToString/#mongodb-expression-exp.-dateToString
*/
$dateToString: {
/**
* The date to convert to string. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The date format specification. <formatString> can be any string literal, containing 0 or more format specifiers. For a list of specifiers available, see Format Specifiers.
*
* If unspecified, $dateToString uses "%Y-%m-%dT%H:%M:%S.%LZ" as the default format.
*
* Changed in version 4.0: The format field is optional if featureCompatibilityVersion (fCV) is set to "4.0" or greater. For more information on fCV, see setFeatureCompatibilityVersion.
*/
format?: FormatString;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*
* @version 3.6
*/
timezone?: tzExpression;
/**
* The value to return if the date is null or missing. The arguments can be any valid expression.
*
* If unspecified, $dateToString returns null if the date is null or missing.
*
* Changed in version 4.0: Requires featureCompatibilityVersion (fCV) set to "4.0" or greater. For more information on fCV, see setFeatureCompatibilityVersion.
*/
onNull?: Expression;
};
}
export interface DateTrunc {
/**
* Truncates a date.
*
* @version 5.0
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dateTrunc/#mongodb-expression-exp.-dateTrunc
*/
$dateTrunc: {
/**
* The date to truncate, specified in UTC. The date can be any expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The unit of time, specified as an expression that must resolve to one of these strings:
* - year
* - quarter
* - week
* - month
* - day
* - hour
* - minute
* - second
* - millisecond
*
* Together, binSize and unit specify the time period used in the $dateTrunc calculation.
*/
unit: StringExpression<DateUnit>;
/**
* The numeric time value, specified as an expression that must resolve to a positive non-zero number. Defaults to 1.
*
* Together, binSize and unit specify the time period used in the $dateTrunc calculation.
*/
binSize?: NumberExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
/**
* Used when the unit is equal to week. Defaults to Sunday. The startOfWeek parameter is an expression that resolves to a case insensitive string:
* - monday (or mon)
* - tuesday (or tue)
* - wednesday (or wed)
* - thursday (or thu)
* - friday (or fri)
* - saturday (or sat)
* - sunday (or sun)
*/
startOfWeek?: StringExpression<StartOfWeek>;
}
}
export interface DayOfMonth {
/**
* Returns the day of the month for a date as a number between 1 and 31.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dayOfMonth/#mongodb-expression-exp.-dayOfMonth
*/
$dayOfMonth: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface DayOfWeek {
/**
* Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dayOfWeek/#mongodb-expression-exp.-dayOfWeek
*/
$dayOfWeek: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface DayOfYear {
/**
* Returns the day of the year for a date as a number between 1 and 366 (leap year).
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/dayOfYear/#mongodb-expression-exp.-dayOfYear
*/
$dayOfYear: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface Hour {
/**
* Returns the hour for a date as a number between 0 and 23.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/hour/#mongodb-expression-exp.-hour
*/
$hour: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface IsoDayOfWeek {
/**
* Returns the weekday number in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).
*
* @version 3.4
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/isoDayOfWeek/#mongodb-expression-exp.-isoDayOfWeek
*/
$isoDayOfWeek: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface IsoWeek {
/**
* Returns the week number in ISO 8601 format, ranging from 1 to 53. Week numbers start at 1 with the week (Monday through Sunday) that contains the year's first Thursday.
*
* @version 3.4
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/isoWeek/#mongodb-expression-exp.-isoWeek
*/
$isoWeek: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface IsoWeekYear {
/**
* Returns the year number in ISO 8601 format. The year starts with the Monday of week 1 (ISO 8601) and ends with the Sunday of the last week (ISO 8601).
*
* @version 3.4
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/isoWeekYear/#mongodb-expression-exp.-isoWeekYear
*/
$isoWeekYear: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface Millisecond {
/**
* Returns the milliseconds of a date as a number between 0 and 999.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/millisecond/#mongodb-expression-exp.-millisecond
*/
$millisecond: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface Minute {
/**
* Returns the minute for a date as a number between 0 and 59.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/minute/#mongodb-expression-exp.-minute
*/
$minute: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface Month {
/**
* Returns the month for a date as a number between 1 (January) and 12 (December).
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/month/#mongodb-expression-exp.-month
*/
$month: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface Second {
/**
* Returns the seconds for a date as a number between 0 and 60 (leap seconds).
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/second/#mongodb-expression-exp.-second
*/
$second: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface ToDate {
/**
* Converts value to a Date.
*
* @version 4.0
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/toDate/#mongodb-expression-exp.-toDate
*/
$toDate: Expression;
}
export interface Week {
/**
* Returns the week number for a date as a number between 0 (the partial week that precedes the first Sunday of the year) and 53 (leap year).
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/week/#mongodb-expression-exp.-week
*/
$week: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface Year {
/**
* Returns the year for a date as a number (e.g. 2014).
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/year/#mongodb-expression-exp.-year
*/
$year: DateExpression | {
/**
* The date to which the operator is applied. <dateExpression> must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.
*/
date: DateExpression;
/**
* The timezone of the operation result. <tzExpression> must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset. If no timezone is provided, the result is displayed in UTC.
*/
timezone?: tzExpression;
};
}
export interface And {
/**
* Returns true only when all its expressions evaluate to true. Accepts any number of argument expressions.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/and/#mongodb-expression-exp.-and
*/
$and: (Expression | Record<string, Expression>)[];
}
export interface Not {
/**
* Returns the boolean value that is the opposite of its argument expression. Accepts a single argument expression.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/not/#mongodb-expression-exp.-not
*/
$not: [Expression];
}
export interface Or {
/**
* Returns true when any of its expressions evaluates to true. Accepts any number of argument expressions.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/or/#mongodb-expression-exp.-or
*/
$or: (Expression | Record<string, Expression>)[];
}
export interface Cmp {
/**
* Returns 0 if the two values are equivalent, 1 if the first value is greater than the second, and -1 if the first value is less than the second.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/cmp/#mongodb-expression-exp.-cmp
*/
$cmp: [Record<string, AnyExpression> | Expression, Record<string, AnyExpression> | Expression];
}
export interface Eq {
/**
* Returns true if the values are equivalent.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/eq/#mongodb-expression-exp.-eq
*/
$eq: AnyExpression | [AnyExpression, AnyExpression];
}
export interface Gt {
/**
* Returns true if the first value is greater than the second.
*
* @see https://docs.mongodb.com/manual/reference/operator/aggregation/gt/#mongodb-expression-exp.-gt
*/