Press n or j to go to the next uncovered block, b, p or k for the previous block.
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 | // Copied from https://github.com/DefinitelyTyped/DefinitelyTyped/pull/36884 // TODO: After merged, you can remove this file. // Type definitions for Mongoose 5.6.5 // Project: http://mongoosejs.com/ // Definitions by: horiuchi <https://github.com/horiuchi> // lukasz-zak <https://github.com/lukasz-zak> // Alorel <https://github.com/Alorel> // jendrikw <https://github.com/jendrikw> // Ethan Resnick <https://github.com/ethanresnick> // vologa <https://github.com/vologab> // jussikinnula <https://github.com/jussikinnula> // ondratra <https://github.com/ondratra> // alfirin <https://github.com/alfirin> // Idan Dardikman <https://github.com/idandrd> // Dominik Heigl <https://github.com/various89> // Fazendaaa <https://github.com/Fazendaaa> // Norman Perrin <https://github.com/NormanPerrin> // Dan Manastireanu <https://github.com/danmana> // stablio <https://github.com/stablio> // Emmanuel Gautier <https://github.com/emmanuelgautier> // Frontend Monster <https://github.com/frontendmonster> // Ming Chen <https://github.com/mingchen> // Olga Isakova <https://github.com/penumbra1> // Orblazer <https://github.com/orblazer> // HughKu <https://github.com/HughKu> // Erik Lopez <https://github.com/niuware> // Vlad Melnik <https://github.com/vladmel1234> // Jarom Loveridge <https://github.com/jloveridge> // Grimmer Kang <https://github.com/grimmer0125> // Richard Davison <https://github.com/richarddd> // lightnet328 <https://github.com/lightnet328> // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 /// <reference types="mongodb" /> /// <reference types="node" /> /* * Guidelines for maintaining these definitions: * - If you spot an error here or there, please submit a PR. * Give some examples/links to documentation if you can. * * For patches and minor releases: * - Browse the changelog at https://github.com/Automattic/mongoose/blob/master/History.md * and make necessary changes. Afterwards, update the version number at the top so we know * which version we are on. * * For major releases: * - Refer to the updated docs at https//mongoosejs.com/docs/api.html * - On the left-hand side of the docs is a list of .js files. Reset and update the TODO list below * then go through one-by-one, making any updates to params list, return type, etc. For documentation * changes just copy/paste them into here. * - Check the files off as you go. Some files below might not have anything in them. That's ok, this * is just a simple heuristic to keep track of our progress. */ /* For easier searching, add a header to each section like so: To find a section, CTRL+F and type "section ___.js" /* * section filename.js * http://mongoosejs.com/docs/api.html#filename-js */ declare module "mongoose" { import events = require('events'); import mongodb = require('mongodb'); import stream = require('stream'); import mongoose = require('mongoose'); /** * Allows for nested objects and arrays to be partial */ export type DeepPartial<T> = { [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U>[] : T[P] extends object ? DeepPartial<T[P]> : T[P]; }; /** * Gets and optionally overwrites the function used to pluralize collection names * @param fn function to use for pluralization of collection names * @returns the current function used to pluralize collection names (defaults to the `mongoose-legacy-pluralize` module's function) */ export function pluralize(fn?: (str: string) => string): (str: string) => string; /* * Some mongoose classes have the same name as the native JS classes * Keep references to native classes using a "Native" prefix */ class NativeBuffer extends global.Buffer { } class NativeDate extends global.Date { } class NativeError extends global.Error { } /* * section index.js * http://mongoosejs.com/docs/api.html#index-js */ export var DocumentProvider: any; // recursive constructor export var Mongoose: new (...args: any[]) => typeof mongoose; type Mongoose = typeof mongoose; export var SchemaTypes: typeof Schema.Types; /** Expose connection states for user-land */ export var STATES: ConnectionStates; /** The default connection of the mongoose module. */ export var connection: Connection; /** An array containing all connections associated with this Mongoose instance. */ export var connections: Connection[]; /** Models registred on the default mongoose connection. */ export var models: { [index: string]: Model<any> }; /** The node-mongodb-native driver Mongoose uses. */ export var mongo: typeof mongodb; /** The Mongoose version */ export var version: string; /** * Opens the default mongoose connection. * Options passed take precedence over options included in connection strings. * @returns pseudo-promise wrapper around this */ export function connect(uris: string, options: ConnectionOptions, callback: (err: mongodb.MongoError) => void): Promise<Mongoose>; export function connect(uris: string, callback: (err: mongodb.MongoError) => void): Promise<Mongoose>; export function connect(uris: string, options?: ConnectionOptions): Promise<Mongoose>; /** * Creates a Connection instance. * Each connection instance maps to a single database. This method is helpful * when mangaging multiple db connections. * @param uri a mongodb:// URI * @param options options to pass to the driver * @returns the created Connection object */ export function createConnection(): Connection; export function createConnection(uri: string, options?: ConnectionOptions ): Connection & { then: Promise<Connection>["then"]; catch: Promise<Connection>["catch"]; }; /** * Disconnects all connections. * @param fn called after all connection close. */ export function disconnect(fn: (error?: any) => void): void; /** Disconnects all connections. */ export function disconnect(): Promise<void>; /** Gets mongoose options */ export function get(key: string): any; /** * Defines a model or retrieves it. * Models defined on the mongoose instance are available to all connection * created by the same mongoose instance. * @param name model name * @param collection (optional, induced from model name) * @param skipInit whether to skip initialization (defaults to false) */ export function model<T extends Document>(name: string, schema?: Schema, collection?: string, skipInit?: boolean): Model<T>; export function model<T extends Document, U extends Model<T>>( name: string, schema?: Schema, collection?: string, skipInit?: boolean ): U; /** * Returns an array of model names created on this instance of Mongoose. * Does not include names of models created using connection.model(). */ export function modelNames(): string[]; /** * Declares a global plugin executed on all Schemas. * Equivalent to calling .plugin(fn) on each Schema you create. * @param fn plugin callback * @param opts optional options */ export function plugin(fn: Function): typeof mongoose; export function plugin<T>(fn: Function, opts: T): typeof mongoose; /** Sets mongoose options */ export function set(key: string, value: any): void; export function startSession(options?: mongodb.SessionOptions, cb?: (err: any, session: mongodb.ClientSession) => void): Promise<mongodb.ClientSession>; export type CastError = Error.CastError; /* * section connection.js * http://mongoosejs.com/docs/api.html#connection-js * * The Connection class exposed by require('mongoose') * is actually the driver's NativeConnection class. * connection.js defines a base class that the native * versions extend. See: * http://mongoosejs.com/docs/api.html#drivers-node-mongodb-native-connection-js */ abstract class ConnectionBase extends events.EventEmitter { /** * For practical reasons, a Connection equals a Db. * @param base a mongoose instance * @event connecting Emitted when connection.{open,openSet}() is executed on this connection. * @event connected Emitted when this connection successfully connects to the db. May be emitted multiple times in reconnected scenarios. * @event open Emitted after we connected and onOpen is executed on all of this connections models. * @event disconnecting Emitted when connection.close() was executed. * @event disconnected Emitted after getting disconnected from the db. * @event close Emitted after we disconnected and onClose executed on all of this connections models. * @event reconnected Emitted after we connected and subsequently disconnected, followed by successfully another successfull connection. * @event error Emitted when an error occurs on this connection. * @event fullsetup Emitted in a replica-set scenario, when primary and at least one seconaries specified in the connection string are connected. * @event all Emitted in a replica-set scenario, when all nodes specified in the connection string are connected. */ constructor(base: typeof mongoose); /** * Opens the connection to MongoDB. * @param uri mongodb connection string * @param options Mongoose forces the db option forceServerObjectId false and cannot be overridden. * Mongoose defaults the server auto_reconnect options to true which can be overridden. * See the node-mongodb-native driver instance for options that it understands. * Options passed take precedence over options included in connection strings. */ openUri(uri: string, options?: ConnectionOptions): Promise<Connection>; openUri(uri: string, callback: (err: any, conn?: Connection) => void): Connection; openUri( uri: string, options: ConnectionOptions, callback?: (err: any, conn?: Connection) => void ): Connection & { then: Promise<Connection>["then"]; catch: Promise<Connection>["catch"]; }; /** Helper for dropDatabase() */ dropDatabase(callback?: (err: any) => void): Promise<any>; /** Helper for creating a collection */ createCollection<T = any>(name: string, options?: mongodb.CollectionCreateOptions): Promise<mongodb.Collection<T>>; createCollection<T = any>(name: string, cb: (err: any, collection: mongodb.Collection<T>) => void): Promise<void>; createCollection<T = any>(name: string, options: mongodb.CollectionCreateOptions, cb?: (err: any, collection: mongodb.Collection) => void): Promise<mongodb.Collection<T>>; /** Helper for dropCollection() */ dropCollection(name: string, callback?: (err: any) => void): Promise<void>; /** Closes the connection */ close(callback?: (err: any) => void): Promise<void>; /** Closes the connection */ close(force?: boolean, callback?: (err: any) => void): Promise<void>; /** * Retrieves a collection, creating it if not cached. * Not typically needed by applications. Just talk to your collection through your model. * @param name name of the collection * @param options optional collection options */ collection(name: string, options?: any): Collection; /** * Defines or retrieves a model. * When no collection argument is passed, Mongoose produces a collection name by passing * the model name to the utils.toCollectionName method. This method pluralizes the name. * If you don't like this behavior, either pass a collection name or set your schemas * collection name option. * @param name the model name * @param schema a schema. necessary when defining a model * @param collection name of mongodb collection (optional) if not given it will be induced from model name * @returns The compiled model */ model<T extends Document>(name: string, schema?: Schema, collection?: string): Model<T>; model<T extends Document, U extends Model<T>>( name: string, schema?: Schema, collection?: string ): U; /** * Removes the model named `name` from this connection, if it exists. You can * use this function to clean up any models you created in your tests to * prevent OverwriteModelErrors. * * @param name if string, the name of the model to remove. If regexp, removes all models whose name matches the regexp. * @returns this */ deleteModel(name: string | RegExp): Connection; /** Returns an array of model names created on this connection. */ modelNames(): string[]; /** A hash of the global options that are associated with this connection */ config: any; /** The mongodb.Db instance, set when the connection is opened */ db: mongodb.Db; /** A hash of the collections associated with this connection */ collections: { [index: string]: Collection }; /** A hash of models registered with this connection */ models: { [index: string]: Model<any> }; /** * Connection ready state * 0 = disconnected * 1 = connected * 2 = connecting * 3 = disconnecting * Each state change emits its associated event name. */ readyState: number; /** mapping of ready states */ states: ConnectionStates; } /** * Connection optional settings. * * see * https://mongoosejs.com/docs/api.html#mongoose_Mongoose-connect * and * http://mongodb.github.io/node-mongodb-native/3.0/api/MongoClient.html * for all available options. * */ interface ConnectionOptions extends mongodb.MongoClientOptions { /** mongoose-specific options */ /** See https://mongoosejs.com/docs/guide.html#bufferCommands */ bufferCommands?: boolean; /** database Name for Mongodb Atlas Connection */ dbName?: string; /** passed to the connection db instance */ db?: any; config?: { /** * set to false to disable automatic index creation for all * models associated with this connection. */ autoIndex?: boolean; }; autoIndex?: boolean; /** Specify a journal write concern (default: false). */ journal?: boolean; /** The current value of the parameter native_parser */ nativeParser?: boolean; safe?: any; slaveOk?: boolean; /** username for authentication */ user?: string; /** password for authentication */ pass?: string; /** If true, this connection will use createIndex() instead of ensureIndex() for automatic index builds via Model.init(). */ useCreateIndex?: boolean; /** See https://mongoosejs.com/docs/connections.html#use-mongo-client **/ useMongoClient?: boolean; /** Flag for using new URL string parser instead of current (deprecated) one */ useNewUrlParser?: boolean; /** Set to false to make findOneAndUpdate() and findOneAndRemove() use native findOneAndUpdate() rather than findAndModify(). */ useFindAndModify?: boolean; // Legacy properties - passed to the connection server instance(s) mongos?: any; server?: any; replset?: any; } interface ClientSession extends mongodb.ClientSession { } /* * section drivers/node-mongodb-native/collection.js * http://mongoosejs.com/docs/api.html#drivers-node-mongodb-native-collection-js */ var Collection: Collection; interface Collection extends CollectionBase { /** * Collection constructor * @param name name of the collection * @param conn A MongooseConnection instance * @param opts optional collection options */ new(name: string, conn: Connection, opts?: any): Collection; /** Formatter for debug print args */ $format(arg: any): string; /** Debug print helper */ $print(name: any, i: any, args: any[]): void; /** Retrieves information about this collections indexes. */ getIndexes(): any; } /* * section drivers/node-mongodb-native/connection.js * http://mongoosejs.com/docs/api.html#drivers-node-mongodb-native-connection-js */ class Connection extends ConnectionBase { /** * Switches to a different database using the same connection pool. * @param name The database name * @returns New Connection Object */ useDb(name: string): Connection; startSession(options?: mongodb.SessionOptions, cb?: (err: any, session: mongodb.ClientSession) => void): Promise<mongodb.ClientSession>; /** Expose the possible connection states. */ static STATES: ConnectionStates; } export enum ConnectionStates { disconnected = 0, connected = 1, connecting = 2, disconnecting = 3, uninitialized = 99, } /* * section error.js * http://mongoosejs.com/docs/api.html#error-js */ class Error extends global.Error { // "MongooseError" for instances of the current class, // an other string for instances of derived classes. name: "MongooseError" | string; /** * MongooseError constructor * @param msg Error message */ constructor(msg: string); /** * The default built-in validator error messages. These may be customized. * As you might have noticed, error messages support basic templating * {PATH} is replaced with the invalid document path * {VALUE} is replaced with the invalid value * {TYPE} is replaced with the validator type such as "regexp", "min", or "user defined" * {MIN} is replaced with the declared min value for the Number.min validator * {MAX} is replaced with the declared max value for the Number.max validator */ static messages: any; /** For backwards compatibility. Same as mongoose.Error.messages */ static Messages: any; } module Error { /** * section error/notFound.js * https://mongoosejs.com/docs/api.html#mongooseerror_MongooseError.DocumentNotFoundError * * An instance of this error class will be returned when `save()` fails * because the underlying * document was not found. The constructor takes one parameter, the * conditions that mongoose passed to `update()` when trying to update * the document. */ export class DocumentNotFoundError extends Error { name: 'DocumentNotFoundError'; filter: any; query: any; constructor(filter: any); } /** * section error/cast.js * https://mongoosejs.com/docs/api.html#mongooseerror_MongooseError.CastError * * An instance of this error class will be returned when mongoose failed to * cast a value. */ export class CastError extends Error { name: 'CastError'; stringValue: string; kind: string; value: any; path: string; reason?: any; model?: any; constructor(type: string, value: any, path: string, reason?: NativeError); setModel(model: any): void; } /** * section error/validation.js * https://mongoosejs.com/docs/api.html#mongooseerror_MongooseError.ValidationError * An instance of this error class will be returned when [validation](/docs/validation.html) failed. * The `errors` property contains an object whose keys are the paths that failed and whose values are * instances of CastError or ValidationError. * */ export class ValidationError extends Error { name: 'ValidationError'; errors: {[path: string]: ValidatorError | CastError}; constructor(instance?: MongooseDocument); /** Console.log helper */ toString(): string; inspect(): object; toJSON(): object; addError(path: string, error: any): void; } /** * section error/validator.js * https://mongoosejs.com/docs/api.html#mongooseerror_MongooseError.ValidatorError * * A `ValidationError` has a hash of `errors` that contain individual `ValidatorError` instances */ export class ValidatorError extends Error { name: 'ValidatorError'; properties: {message: string, type?: string, path?: string, value?: any, reason?: any}; kind: string; path: string; value: any; reason: any; constructor(properties: {message?: string, type?: string, path?: string, value?: any, reason?: any}); formatMessage(msg: string | Function, properties: any): string; toString(): string; } /** * section error/version.js * https://mongoosejs.com/docs/api.html#mongooseerror_MongooseError.VersionError * * An instance of this error class will be returned when you call `save()` after * the document in the database was changed in a potentially unsafe way. See * the [`versionKey` option](http://mongoosejs.com/docs/guide.html#versionKey) for more information. */ export class VersionError extends Error { name: 'VersionError'; version: any; modifiedPaths: Array<any>; constructor(doc: MongooseDocument, currentVersion: any, modifiedPaths: any); } /** * section error/parallelSave.js * https://mongoosejs.com/docs/api.html#mongooseerror_MongooseError.ParallelSaveError * * An instance of this error class will be returned when you call `save()` multiple * times on the same document in parallel. See the [FAQ](http://mongoosejs.com/docs/faq.html) for more * information. */ export class ParallelSaveError extends Error { name: 'ParallelSaveError'; constructor(doc: MongooseDocument); } /** * section error/overwriteModel.js * https://mongoosejs.com/docs/api.html#mongooseerror_MongooseError.OverwriteModelError * * Thrown when a model with the given name was already registered on the connection. * See [the FAQ about `OverwriteModelError`](http://mongoosejs.com/docs/faq.html#overwrite-model-error). */ export class OverwriteModelError extends Error { name: 'OverwriteModelError'; constructor(name: string); } /** * section error/missingSchema.js * https://mongoosejs.com/docs/api.html#mongooseerror_MongooseError.MissingSchemaError * * Thrown when you try to access a model that has not been registered yet */ export class MissingSchemaError extends Error { name: 'MissingSchemaError'; constructor(name: string); } /** * section error/divergentArray.js * https://mongoosejs.com/docs/api.html#mongooseerror_MongooseError.DivergentArrayError * * An instance of this error will be returned if you used an array projection * and then modified the array in an unsafe way. */ export class DivergentArrayError extends Error { name: 'DivergentArrayError'; constructor(paths: Array<any>); } } interface EachAsyncOptions { /** defaults to 1 */ parallel?: number; } /* * section querycursor.js * https://mongoosejs.com/docs/api.html#querycursor-js * * Callback signatures are from: https://mongodb.github.io/node-mongodb-native/2.1/api/Cursor.html#close * QueryCursor can only be accessed by query#cursor(), we only * expose its interface to enable type-checking. */ interface QueryCursor<T extends Document> extends stream.Readable { /** * A QueryCursor is a concurrency primitive for processing query results * one document at a time. A QueryCursor fulfills the Node.js streams3 API, * in addition to several other mechanisms for loading documents from MongoDB * one at a time. * Unless you're an advanced user, do not instantiate this class directly. * Use Query#cursor() instead. * @param options query options passed to .find() * @event cursor Emitted when the cursor is created * @event error Emitted when an error occurred * @event data Emitted when the stream is flowing and the next doc is ready * @event end Emitted when the stream is exhausted */ constructor(query: Query<T>, options: any): QueryCursor<T>; /** Marks this cursor as closed. Will stop streaming and subsequent calls to next() will error. */ close(callback?: (error: any, result: any) => void): Promise<any>; /** * Execute fn for every document in the cursor. If fn returns a promise, * will wait for the promise to resolve before iterating on to the next one. * Returns a promise that resolves when done. * @param fn Function to be executed for every document in the cursor * @param callback Executed when all docs have been processed */ eachAsync(fn: (doc: T) => any, callback?: (err: any) => void): Promise<T>; /** * Execute fn for every document in the cursor. If fn returns a promise, * will wait for the promise to resolve before iterating on to the next one. * Returns a promise that resolves when done. * @param fn Function to be executed for every document in the cursor * @param options Async options (e. g. parallel function execution) * @param callback Executed when all docs have been processed */ eachAsync(fn: (doc: T) => any, options: EachAsyncOptions, callback?: (err: any) => void): Promise<T>; /** * Registers a transform function which subsequently maps documents retrieved * via the streams interface or .next() */ map(fn: (doc: T) => T): this; /** * Get the next document from this cursor. Will return null when there are * no documents left. */ next(callback?: (err: any, doc?: T) => void): Promise<any>; } /* * section virtualtype.js * http://mongoosejs.com/docs/api.html#virtualtype-js */ class VirtualType { /** This is what mongoose uses to define virtual attributes via Schema.prototype.virtual. */ constructor(options: any, name: string); /** Applies getters to value using optional scope. */ applyGetters(value: any, scope: any): any; /** Applies setters to value using optional scope. */ applySetters(value: any, scope: any): any; /** Defines a getter. */ get(fn: Function): this; /** Defines a setter. */ set(fn: Function): this; } /* * section schema.js * http://mongoosejs.com/docs/api.html#schema-js */ class Schema<T = any, U = any> extends events.EventEmitter { /** * Schema constructor. * When nesting schemas, (children in the example above), always declare * the child schema first before passing it into its parent. * @event init Emitted after the schema is compiled into a Model. */ constructor(definition?: SchemaDefinition, options?: SchemaOptions); /** Adds key path / schema type pairs to this schema. */ add(obj: SchemaDefinition, prefix?: string): void; /** Return a deep copy of this schema */ clone(): Schema; /** * Iterates the schemas paths similar to Array.forEach. * @param fn callback function * @returns this */ eachPath(fn: (path: string, type: SchemaType) => void): this; /** * Gets a schema option. * @param key option name */ get(key: string): any; /** * Defines an index (most likely compound) for this schema. * @param options Options to pass to MongoDB driver's createIndex() function * @param options.expires Mongoose-specific syntactic sugar, uses ms to convert * expires option into seconds for the expireAfterSeconds in the above link. */ index(fields: any, options?: { expires?: string; [other: string]: any; }): this; /** Compiles indexes from fields and schema-level indexes */ indexes(): any[]; /** * Loads an ES6 class into a schema. Maps setters + getters, static methods, and * instance methods to schema virtuals, statics, and methods. */ loadClass(model: Function): this; /** * Adds an instance method to documents constructed from Models compiled from this schema. * If a hash of name/fn pairs is passed as the only argument, each name/fn pair will be added as methods. */ method<F extends keyof T>(method: F, fn: T[F]): this; method(methodObj: { [F in keyof T]: T[F] }): this; /** * Gets/sets schema paths. * Sets a path (if arity 2) * Gets a path (if arity 1) */ path(path: string): SchemaType; path(path: string, constructor: any): this; /** * Returns the pathType of path for this schema. * @returns whether it is a real, virtual, nested, or ad-hoc/undefined path. */ pathType(path: string): string; /** * Registers a plugin for this schema. * @param plugin callback */ plugin(plugin: (schema: Schema) => void): this; plugin<T>(plugin: (schema: Schema, options: T) => void, opts: T): this; /** * Defines a post hook for the document * Post hooks fire on the event emitted from document instances of Models compiled * from this schema. * @param method name of the method to hook * @param fn callback */ post<T extends Document>(method: string | RegExp, fn: ( doc: T, next: (err?: NativeError) => void ) => void): this; post<T extends Document>(method: string | RegExp, fn: ( error: mongodb.MongoError, doc: T, next: (err?: NativeError) => void ) => void): this; /** * Defines a pre hook for the document. */ pre<T extends Document = Document>( method: "init" | "validate" | "save" | "remove", fn: HookSyncCallback<T>, errorCb?: HookErrorCallback ): this; pre<T extends Query<any> = Query<any>>( method: | "count" | "find" | "findOne" | "findOneAndRemove" | "findOneAndUpdate" | "update" | "updateOne" | "updateMany", fn: HookSyncCallback<T>, errorCb?: HookErrorCallback ): this; pre<T extends Aggregate<any> = Aggregate<any>>( method: "aggregate", fn: HookSyncCallback<T>, errorCb?: HookErrorCallback ): this; pre<T extends Model<Document> = Model<Document>>( method: "insertMany", fn: HookSyncCallback<T>, errorCb?: HookErrorCallback ): this; pre<T extends Document | Model<Document> | Query<any> | Aggregate<any>>( method: string, fn: HookSyncCallback<T>, errorCb?: HookErrorCallback ): this; pre<T extends Document = Document>( method: "init" | "validate" | "save" | "remove", parallel: boolean, fn: HookAsyncCallback<T>, errorCb?: HookErrorCallback ): this; pre<T extends Query<any> = Query<any>>( method: | "count" | "find" | "findOne" | "findOneAndRemove" | "findOneAndUpdate" | "update" | "updateOne" | "updateMany", parallel: boolean, fn: HookAsyncCallback<T>, errorCb?: HookErrorCallback ): this; pre<T extends Aggregate<any> = Aggregate<any>>( method: "aggregate", parallel: boolean, fn: HookAsyncCallback<T>, errorCb?: HookErrorCallback ): this; pre<T extends Model<Document> = Model<Document>>( method: "insertMany", parallel: boolean, fn: HookAsyncCallback<T>, errorCb?: HookErrorCallback ): this; pre<T extends Document | Model<Document> | Query<any> | Aggregate<any>>( method: string | RegExp, parallel: boolean, fn: HookAsyncCallback<T>, errorCb?: HookErrorCallback ): this; /** * Adds a method call to the queue. * @param name name of the document method to call later * @param args arguments to pass to the method */ queue(name: string, args: any[]): this; /** * Removes the given path (or [paths]). */ remove(path: string | string[]): void; /** * @param invalidate refresh the cache * @returns an Array of path strings that are required by this schema. */ requiredPaths(invalidate?: boolean): string[]; /** * Sets/gets a schema option. * @param key option name * @param value if not passed, the current option value is returned */ set<T extends keyof SchemaOptions>(key: T): SchemaOptions[T]; set<T extends keyof SchemaOptions>(key: T, value: SchemaOptions[T]): this; /** * Adds static "class" methods to Models compiled from this schema. */ static<F extends keyof U>(name: F, fn: U[F]): this; static(nameObj: { [F in keyof U]: U[F] }): this; /** Creates a virtual type with the given name. */ virtual(name: string, options?: any): VirtualType; /** Returns the virtual type with the given name. */ virtualpath(name: string): VirtualType; /** The allowed index types */ static indexTypes: string[]; /** * Reserved document keys. * Keys in this object are names that are rejected in schema declarations * b/c they conflict with mongoose functionality. Using these key name * will throw an error. */ static reserved: any; /** Object of currently defined methods on this schema. */ methods: { [F in keyof T]: T[F] }; /** Object of currently defined statics on this schema. */ statics: { [F in keyof U]: U[F] }; /** Object of currently defined query helpers on this schema. */ query: any; /** The original object passed to the schema constructor */ obj: any; } // Hook functions: https://github.com/vkarpov15/hooks-fixed interface HookSyncCallback<T> { (this: T, next: HookNextFunction, docs: any[]): Promise<any> | void; } interface HookAsyncCallback<T> { (this: T, next: HookNextFunction, done: HookDoneFunction, docs: any[]): Promise<any> | void; } interface HookErrorCallback { (error?: Error): any; } interface HookNextFunction { (error?: Error): any; } interface HookDoneFunction { (error?: Error): any; } interface SchemaOptions { /** defaults to false (which means use the connection's autoIndex option) */ autoIndex?: boolean; /** defaults to true */ bufferCommands?: boolean; /** defaults to false */ capped?: boolean | number | { size?: number; max?: number; autoIndexId?: boolean; }; /** Sets a default collation for every query and aggregation. */ collation?: CollationOptions; /** no default */ collection?: string; /** defaults to "__t" */ discriminatorKey?: string; /** defaults to false. */ emitIndexErrors?: boolean; excludeIndexes?: any; /** defaults to true */ id?: boolean; /** defaults to true */ _id?: boolean; /** controls document#toObject behavior when called manually - defaults to true */ minimize?: boolean; read?: string; writeConcern?: WriteConcern; /** defaults to true. */ safe?: boolean | { w?: number | string; wtimeout?: number; j?: boolean }; /** defaults to null */ shardKey?: object; /** defaults to true */ strict?: boolean | 'throw'; /** no default */ toJSON?: DocumentToObjectOptions; /** no default */ toObject?: DocumentToObjectOptions; /** defaults to 'type' */ typeKey?: string; /** defaults to false */ useNestedStrict?: boolean; /** defaults to false */ usePushEach?: boolean; /** defaults to true */ validateBeforeSave?: boolean; /** defaults to "__v" */ versionKey?: string | boolean; /** * By default, Mongoose will automatically * select() any populated paths. * To opt out, set selectPopulatedPaths to false. */ selectPopulatedPaths?: boolean; /** * skipVersioning allows excluding paths from * versioning (the internal revision will not be * incremented even if these paths are updated). */ skipVersioning?: any; /** * Validation errors in a single nested schema are reported * both on the child and on the parent schema. * Set storeSubdocValidationError to false on the child schema * to make Mongoose only report the parent error. */ storeSubdocValidationError?: boolean; /** * If set timestamps, mongoose assigns createdAt * and updatedAt fields to your schema, the type * assigned is Date. */ timestamps?: boolean | SchemaTimestampsConfig; } interface SchemaTimestampsConfig { createdAt?: boolean | string; updatedAt?: boolean | string; } /* * Intellisense for Schema definitions */ interface SchemaDefinition { [path: string]: SchemaTypeOpts<any> | Schema | SchemaType; } /* * The standard options available when configuring a schema type: * new Schema({ * name: { * type: String, * required: true, * ... * } * }); * * Note: the properties have Object as a fallback type: | Object * because this interface does not apply to a schematype that * does not have a type property. Ex: * new Schema({ * name: { * first: String, // since name does not have a "type" property * last: String // first and last can have any valid type * ... * } * }); * * References: * - http://mongoosejs.com/docs/schematypes.html * - http://mongoosejs.com/docs/api.html#schema_Schema.Types */ interface SchemaTypeOpts<T> { alias?: string; /* Common Options for all schema types */ type?: T; /** Sets a default value for this SchemaType. */ default?: SchemaTypeOpts.DefaultFn<T> | T; /** * Getters allow you to transform the representation of the data as it travels * from the raw mongodb document to the value that you see. */ get?: (value: T, schematype?: this) => T | any; /** Declares the index options for this schematype. */ index?: SchemaTypeOpts.IndexOpts | boolean | string; /** * Adds a required validator to this SchemaType. The validator gets added * to the front of this SchemaType's validators array using unshift(). */ required?: SchemaTypeOpts.RequiredFn<T> | boolean | [boolean, string] | string | [string, string] | any; /** * Sets default select() behavior for this path. * Set to true if this path should always be included in the results, false * if it should be excluded by default. This setting can be overridden at * the query level. */ select?: boolean | any; /** * Setters allow you to transform the data before it gets to the raw mongodb * document and is set as a value on an actual key. */ set?: (value: T, schematype?: this) => T | any; /** Declares a sparse index. */ sparse?: boolean | any; /** Declares a full text index. */ text?: boolean | any; /** * Adds validator(s) for this document path. * Validators always receive the value to validate as their first argument * and must return Boolean. Returning false means validation failed. */ validate?: RegExp | [RegExp, string] | SchemaTypeOpts.ValidateFn<T> | [SchemaTypeOpts.ValidateFn<T>, string] | SchemaTypeOpts.ValidateOpts | SchemaTypeOpts.AsyncValidateOpts | SchemaTypeOpts.AsyncPromiseValidationFn<T> | SchemaTypeOpts.AsyncPromiseValidationOpts | (SchemaTypeOpts.ValidateOpts | SchemaTypeOpts.AsyncValidateOpts | SchemaTypeOpts.AsyncPromiseValidationFn<T> | SchemaTypeOpts.AsyncPromiseValidationOpts)[]; /** Declares an unique index. */ unique?: boolean | any; /* Options for specific schema types (String, Number, Date, etc.) */ /** String only - Adds an enum validator */ enum?: T[] | SchemaTypeOpts.EnumOpts<T> | any; /** String only - Adds a lowercase setter. */ lowercase?: boolean | any; /** String only - Sets a regexp validator. */ match?: RegExp | [RegExp, string] | any; /** String only - Sets a maximum length validator. */ maxlength?: number | [number, string] | any; /** String only - Sets a minimum length validator. */ minlength?: number | [number, string] | any; /** String only - Adds a trim setter. */ trim?: boolean | any; /** String only - Adds an uppercase setter. */ uppercase?: boolean | any; /** * Date, Number only - Sets a minimum number validator. * Sets a minimum date validator. */ min?: number | [number, string] | Date | [Date, string] | any; /** * Date, Number only - Sets a maximum number validator. * Sets a maximum date validator. */ max?: number | [number, string] | Date | [Date, string] | any; /** * Date only - Declares a TTL index (rounded to the nearest second) * for Date types only. */ expires?: number | string | any; /** ObjectId only - Adds an auto-generated ObjectId default if turnOn is true. */ auto?: boolean | any; [other: string]: any; } // Interfaces specific to schema type options should be scoped in this namespace namespace SchemaTypeOpts { interface DefaultFn<T> { (...args: any[]): T; } interface RequiredFn<T> { (required: boolean, message?: string): T; } interface ValidateFn<T> { (value: T): boolean; } interface AsyncValidateFn<T> { (value: T, done: (result: boolean) => void): void; } interface ValidateOptsBase { msg?: string; type?: string; } interface ValidateOpts extends ValidateOptsBase { /** deprecated */ isAsync?: false; validator?: RegExp | ValidateFn<any>; } interface AsyncValidateOpts extends ValidateOptsBase { /** deprecated */ isAsync: true; validator: AsyncValidateFn<any>; } interface AsyncPromiseValidationFn<T> { (value: T): Promise<boolean>; } interface AsyncPromiseValidationOpts extends ValidateOptsBase { validator: AsyncPromiseValidationFn<any>; } interface EnumOpts<T> { values?: T[]; message?: string; } interface IndexOpts { background?: boolean, expires?: number | string sparse?: boolean, type?: string, unique?: boolean, } } /* * section document.js * http://mongoosejs.com/docs/api.html#document-js */ interface MongooseDocument extends MongooseDocumentOptionals { } class MongooseDocument { /** Checks if a path is set to its default. */ $isDefault(path?: string): boolean; /** Getter/setter around the session associated with this document. */ $session(session?: ClientSession): ClientSession; /** * Takes a populated field and returns it to its unpopulated state. * If the path was not populated, this is a no-op. */ depopulate(path?: string): this; /** * Returns true if the Document stores the same data as doc. * Documents are considered equal when they have matching _ids, unless neither document * has an _id, in which case this function falls back to usin deepEqual(). * @param doc a document to compare */ equals(doc: MongooseDocument): boolean; /** * Explicitly executes population and returns a promise. * Useful for ES2015 integration. * @returns promise that resolves to the document when population is done */ execPopulate(): Promise<this>; /** Checks if path was explicitly selected. If no projection, always returns true. */ isDirectSelected(path: string): boolean; /** * Returns the value of a path. * @param type optionally specify a type for on-the-fly attributes */ get(path: string, type?: any): any; /** * Initializes the document without setters or marking anything modified. * Called internally after a document is returned from mongodb. * @param doc document returned by mongo * @param opts Options */ init(doc: MongooseDocument, opts?: any): this; /** Helper for console.log */ inspect(options?: any): any; /** * Marks a path as invalid, causing validation to fail. * The errorMsg argument will become the message of the ValidationError. * The value argument (if passed) will be available through the ValidationError.value property. * @param path the field to invalidate * @param errorMsg the error which states the reason path was invalid * @param value optional invalid value * @param kind optional kind property for the error * @returns the current ValidationError, with all currently invalidated paths */ invalidate(path: string, errorMsg: string | NativeError, value?: any, kind?: string): Error.ValidationError | boolean; /** Returns true if path was directly set and modified, else false. */ isDirectModified(path: string): boolean; /** Checks if path was initialized */ isInit(path: string): boolean; /** * Returns true if this document was modified, else false. * If path is given, checks if a path or any full path containing path as part of its path * chain has been modified. */ isModified(path?: string): boolean; /** Checks if path was selected in the source query which initialized this document. */ isSelected(path: string): boolean; /** * Marks the path as having pending changes to write to the db. * Very helpful when using Mixed types. * @param path the path to mark modified */ markModified(path: string): void; /** Returns the list of paths that have been modified. */ modifiedPaths(): string[]; /** * Populates document references, executing the callback when complete. * If you want to use promises instead, use this function with * execPopulate() * Population does not occur unless a callback is passed or you explicitly * call execPopulate(). Passing the same path a second time will overwrite * the previous path options. See Model.populate() for explaination of options. * @param path The path to populate or an options object * @param names The properties to fetch from the populated document * @param callback When passed, population is invoked */ populate(callback: (err: any, res: this) => void): this; populate(path: string, callback?: (err: any, res: this) => void): this; populate(path: string, names: string, callback?: (err: any, res: this) => void): this; populate(options: ModelPopulateOptions | ModelPopulateOptions[], callback?: (err: any, res: this) => void): this; /** Gets _id(s) used during population of the given path. If the path was not populated, undefined is returned. */ populated(path: string): any; /** * Sets the value of a path, or many paths. * @param path path or object of key/vals to set * @param val the value to set * @param type optionally specify a type for "on-the-fly" attributes * @param options optionally specify options that modify the behavior of the set */ set(path: string, val: any, options?: any): this; set(path: string, val: any, type: any, options?: any): this; set(value: any): this; /** * The return value of this method is used in calls to JSON.stringify(doc). * This method accepts the same options as Document#toObject. To apply the * options to every document of your schema by default, set your schemas * toJSON option to the same argument. */ toJSON(options?: DocumentToObjectOptions): any; /** * Converts this document into a plain javascript object, ready for storage in MongoDB. * Buffers are converted to instances of mongodb.Binary for proper storage. */ toObject(options?: DocumentToObjectOptions): any; /** Helper for console.log */ toString(): string; /** * Clears the modified state on the specified path. * @param path the path to unmark modified */ unmarkModified(path: string): void; /** Sends an replaceOne command with this document _id as the query selector. */ replaceOne(replacement: any, callback?: (err: any, raw: any) => void): Query<any>; /** Sends an update command with this document _id as the query selector. */ update(doc: any, callback?: (err: any, raw: any) => void): Query<any>; update(doc: any, options: ModelUpdateOptions, callback?: (err: any, raw: any) => void): Query<any>; /** Sends an updateOne command with this document _id as the query selector. */ updateOne(doc: any, callback?: (err: any, raw: any) => void): Query<any>; updateOne(doc: any, options: ModelUpdateOptions, callback?: (err: any, raw: any) => void): Query<any>; /** * Executes registered validation rules for this document. * @param optional options internal options * @param callback callback called after validation completes, passing an error if one occurred */ validate(callback?: (err: any) => void): Promise<void>; validate(optional: any, callback?: (err: any) => void): Promise<void>; /** * Executes registered validation rules (skipping asynchronous validators) for this document. * This method is useful if you need synchronous validation. * @param pathsToValidate only validate the given paths * @returns ValidationError if there are errors during validation, or undefined if there is no error. */ validateSync(pathsToValidate?: string | string[]): Error.ValidationError; /** Hash containing current validation errors. */ errors: any; /** This documents _id. */ _id: any; /** Boolean flag specifying if the document is new. */ isNew: boolean; /** The documents schema. */ schema: Schema; } interface MongooseDocumentOptionals { /** * Virtual getter that by default returns the document's _id field cast to a string, * or in the case of ObjectIds, its hexString. This id getter may be disabled by * passing the option { id: false } at schema construction time. If disabled, id * behaves like any other field on a document and can be assigned any value. */ id?: any; } interface DocumentToObjectOptions { /** apply all getters (path and virtual getters) */ getters?: boolean; /** apply virtual getters (can override getters option) */ virtuals?: boolean; /** remove empty objects (defaults to true) */ minimize?: boolean; /** * A transform function to apply to the resulting document before returning * @param doc The mongoose document which is being converted * @param ret The plain object representation which has been converted * @param options The options in use (either schema options or the options passed inline) */ transform?: (doc: any, ret: any, options: any) => any; /** depopulate any populated paths, replacing them with their original refs (defaults to false) */ depopulate?: boolean; /** whether to include the version key (defaults to true) */ versionKey?: boolean; /** whether to convert Maps to POJOs. (defaults to false) */ flattenMaps?: boolean; } namespace Types { /* * section types/subdocument.js * http://mongoosejs.com/docs/api.html#types-subdocument-js */ class Subdocument extends MongooseDocument { /** Returns the top level document of this sub-document. */ ownerDocument(): MongooseDocument; /** * Null-out this subdoc * @param callback optional callback for compatibility with Document.prototype.remove */ remove(callback?: (err: any) => void): void; remove(options: any, callback?: (err: any) => void): void; } /* * section types/array.js * http://mongoosejs.com/docs/api.html#types-array-js */ class Array<T> extends global.Array<T> { /** * Atomically shifts the array at most one time per document save(). * Calling this mulitple times on an array before saving sends the same command as * calling it once. This update is implemented using the MongoDB $pop method which * enforces this restriction. */ $shift(): T; /** Alias of pull */ remove(...args: any[]): this; /** * Pops the array atomically at most one time per document save(). * Calling this mulitple times on an array before saving sends the same command as * calling it once. This update is implemented using the MongoDB $pop method which * enforces this restriction. */ $pop(): T; /** * Adds values to the array if not already present. * @returns the values that were added */ addToSet(...args: any[]): T[]; /** * Return the index of obj or -1 if not found. * @param obj he item to look for */ indexOf(obj: any): number; /** Helper for console.log */ inspect(): any; /** * Marks the entire array as modified, which if saved, will store it as a $set * operation, potentially overwritting any changes that happen between when you * retrieved the object and when you save it. * @returns new length of the array */ nonAtomicPush(...args: any[]): number; /** * Wraps Array#pop with proper change tracking. * marks the entire array as modified which will pass the entire thing to $set * potentially overwritting any changes that happen between when you retrieved * the object and when you save it. */ pop(): T; /** * Pulls items from the array atomically. Equality is determined by casting * the provided value to an embedded document and comparing using * the Document.equals() function. */ pull(...args: any[]): this; /** * Wraps Array#push with proper change tracking. * @returns new length of the array */ push(...args: any[]): number; /** Sets the casted val at index i and marks the array modified. */ set(i: number, val: any): this; /** * Wraps Array#shift with proper change tracking. * Marks the entire array as modified, which if saved, will store it as a $set operation, * potentially overwritting any changes that happen between when you retrieved the object * and when you save it. */ shift(): T; /** * Wraps Array#sort with proper change tracking. * Marks the entire array as modified, which if saved, will store it as a $set operation, * potentially overwritting any changes that happen between when you retrieved the object * and when you save it. */ // some lib.d.ts have return type "this" and others have return type "T[]" // which causes errors. Let the inherited array provide the sort() method. //sort(compareFn?: (a: T, b: T) => number): T[]; /** * Wraps Array#splice with proper change tracking and casting. * Marks the entire array as modified, which if saved, will store it as a $set operation, * potentially overwritting any changes that happen between when you retrieved the object * and when you save it. */ splice(...args: any[]): T[]; /** Returns a native js Array. */ toObject(options?: any): T[]; /** * Wraps Array#unshift with proper change tracking. * Marks the entire array as modified, which if saved, will store it as a $set operation, * potentially overwritting any changes that happen between when you retrieved the object * and when you save it. */ unshift(...args: any[]): number; } /* * section types/documentarray.js * http://mongoosejs.com/docs/api.html#types-documentarray-js */ class DocumentArray<T extends MongooseDocument> extends Types.Array<T> { /** * Creates a subdocument casted to this schema. * This is the same subdocument constructor used for casting. * @param obj the value to cast to this arrays SubDocument schema */ create(obj: any): T; /** * Searches array items for the first document with a matching _id. * @returns the subdocument or null if not found. */ id(id: ObjectId | string | number | NativeBuffer): T; /** Helper for console.log */ inspect(): T[]; /** * Returns a native js Array of plain js objects * @param options optional options to pass to each documents toObject * method call during conversion */ toObject(options?: any): T[]; } /* * section types/buffer.js * http://mongoosejs.com/docs/api.html#types-buffer-js */ class Buffer extends global.Buffer { /** * Copies the buffer. * Buffer#copy does not mark target as modified so you must copy * from a MongooseBuffer for it to work as expected. This is a * work around since copy modifies the target, not this. */ copy(target: NativeBuffer, ...nodeBufferArgs: any[]): number; /** Determines if this buffer is equals to other buffer */ equals(other: NativeBuffer): boolean; /** Sets the subtype option and marks the buffer modified. */ subtype(subtype: number): void; /** Converts this buffer to its Binary type representation. */ toObject(subtype?: number): mongodb.Binary; /** Writes the buffer. */ write(string: string, ...nodeBufferArgs: any[]): number; } /* * section types/objectid.js * http://mongoosejs.com/docs/api.html#types-objectid-js */ var ObjectId: ObjectIdConstructor; // mongodb.ObjectID does not allow mongoose.Types.ObjectId(id). This is // commonly used in mongoose and is found in an example in the docs: // http://mongoosejs.com/docs/api.html#aggregate_Aggregate // constructor exposes static methods of mongodb.ObjectID and ObjectId(id) type ObjectIdConstructor = typeof mongodb.ObjectID & { (s?: string | number): mongodb.ObjectID; }; // var objectId: mongoose.Types.ObjectId should reference mongodb.ObjectID not // the ObjectIdConstructor, so we add the interface below interface ObjectId extends mongodb.ObjectID { } class Decimal128 extends mongodb.Decimal128 { } /* * section types/embedded.js * http://mongoosejs.com/docs/api.html#types-embedded-js */ class Embedded extends MongooseDocument { /** Helper for console.log */ inspect(): any; /** * Marks a path as invalid, causing validation to fail. * @param path the field to invalidate * @param err error which states the reason path was invalid */ invalidate(path: string, err: string | NativeError): boolean; /** Returns the top level document of this sub-document. */ ownerDocument(): MongooseDocument; /** Returns this sub-documents parent document. */ parent(): MongooseDocument; /** Returns this sub-documents parent array. */ parentArray(): DocumentArray<MongooseDocument>; /** Removes the subdocument from its parent array. */ remove(options?: { noop?: boolean; }, fn?: (err: any) => void): this; /** * Marks the embedded doc modified. * @param path the path which changed */ markModified(path: string): void; } } /* * section query.js * http://mongoosejs.com/docs/api.html#query-js * * Query<T> is for backwards compatibility. Example: Query<T>.find() returns Query<T[]>. * If later in the query chain a method returns Query<T>, we will need to know type T. * So we save this type as the second type parameter in DocumentQuery. Since people have * been using Query<T>, we set it as an alias of DocumentQuery. * * Furthermore, Query<T> is used for function that has an option { rawResult: true }. * for instance findOneAndUpdate. */ class Query<T> extends DocumentQuery<T, any> { } class DocumentQuery<T, DocType extends Document, QueryHelpers = {}> extends mquery { /** * Specifies a javascript function or expression to pass to MongoDBs query system. * Only use $where when you have a condition that cannot be met using other MongoDB * operators like $lt. Be sure to read about all of its caveats before using. * @param js javascript string or function */ $where(js: string | Function): this; /** * Specifies an $all query condition. * When called with one argument, the most recent path passed to where() is used. */ all(val: number): this; all(path: string, val: number): this; /** * Specifies arguments for a $and condition. * @param array array of conditions */ and(array: any[]): this; /** Specifies the batchSize option. Cannot be used with distinct() */ batchSize(val: number): this; /** Get the current error flag value */ error(): Error | null; /** Unset the error flag set on this query */ error(unset: null): this; /** * Set the error flag on this query * @param err The error flag */ error(err: Error): this; /** * Specifies a $box condition * @param Upper Right Coords */ box(val: any): this; box(lower: number[], upper: number[]): this; /** Casts this query to the schema of model, If obj is present, it is cast instead of this query.*/ cast(model: any, obj?: any): any; /** * Executes the query returning a Promise which will be * resolved with either the doc(s) or rejected with the error. * Like .then(), but only takes a rejection handler. */ catch<TRes>(reject?: (err: any) => void | TRes | PromiseLike<TRes>): Promise<TRes>; /** * DEPRECATED Alias for circle * Specifies a $center or $centerSphere condition. * @deprecated Use circle instead. */ center(area: any): this; center(path: string, area: any): this; /** * DEPRECATED Specifies a $centerSphere condition * @deprecated Use circle instead. */ centerSphere(path: string, val: any): this; centerSphere(val: any): this; /** Specifies a $center or $centerSphere condition. */ circle(area: any): this; circle(path: string, area: any): this; /** Adds a collation to this op (MongoDB 3.4 and up) */ collation(value: CollationOptions): this; /** Specifies the comment option. Cannot be used with distinct() */ comment(val: string): this; /** * Specifying this query as a count query. Passing a callback executes the query. * @param criteria mongodb selector */ count(callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; count(criteria: any, callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; /** * Specifies this query as a `countDocuments()` query. Behaves like `count()`, * except it always does a full collection scan when passed an empty filter `{}`. * * There are also minor differences in how `countDocuments()` handles * [`$where` and a couple geospatial operators](http://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#countDocuments). * versus `count()`. * * Passing a `callback` executes the query. * * This function triggers the following middleware. * * - `countDocuments()` * * * @param {Object} [criteria] mongodb selector * @param {Function} [callback] optional params are (error, count) * @return {Query} this */ countDocuments(callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; countDocuments(criteria: any, callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; /** * Estimates the number of documents in the MongoDB collection. Faster than * using `countDocuments()` for large collections because * `estimatedDocumentCount()` uses collection metadata rather than scanning * the entire collection. * * @param {Object} [options] passed transparently to the [MongoDB driver](http://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#estimatedDocumentCount) * @param {Function} [callback] optional params are (error, count) * @return {Query} this */ estimatedDocumentCount(callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; estimatedDocumentCount(options: any, callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; /** * Returns a wrapper around a mongodb driver cursor. A Query<T>Cursor exposes a * Streams3-compatible interface, as well as a .next() function. */ cursor(options?: any): QueryCursor<DocType>; /** Declares or executes a distict() operation. Passing a callback executes the query. */ distinct(callback?: (err: any, res: any[]) => void): Query<any[]> & QueryHelpers; distinct(field: string, callback?: (err: any, res: any[]) => void): Query<any[]> & QueryHelpers; distinct(field: string, criteria: any | Query<any>, callback?: (err: any, res: any[]) => void): Query<any[]> & QueryHelpers; /** Specifies an $elemMatch condition */ elemMatch(criteria: (elem: Query<any>) => void): this; elemMatch(criteria: any): this; elemMatch(path: string | any | Function, criteria: (elem: Query<any>) => void): this; elemMatch(path: string | any | Function, criteria: any): this; /** Specifies the complementary comparison value for paths specified with where() */ equals<T>(val: T): this; /** Executes the query */ exec(callback?: (err: NativeError, res: T) => void): Promise<T>; exec(operation: string | Function, callback?: (err: any, res: T) => void): Promise<T>; /** Specifies an $exists condition */ exists(val?: boolean): this; exists(path: string, val?: boolean): this; /** * Finds documents. When no callback is passed, the query is not executed. When the * query is executed, the result will be an array of documents. * @param criteria mongodb selector */ find(callback?: (err: any, res: DocType[]) => void): DocumentQuery<DocType[], DocType> & QueryHelpers; find(criteria: any, callback?: (err: any, res: DocType[]) => void): DocumentQuery<DocType[], DocType> & QueryHelpers; /** * Declares the query a findOne operation. When executed, the first found document is * passed to the callback. Passing a callback executes the query. The result of the query * is a single document. * @param criteria mongodb selector * @param projection optional fields to return */ findOne(callback?: (err: any, res: DocType | null) => void): DocumentQuery<DocType | null, DocType> & QueryHelpers; findOne(criteria: any, callback?: (err: any, res: DocType | null) => void): DocumentQuery<DocType | null, DocType> & QueryHelpers; /** * Issues a mongodb findAndModify remove command. * Finds a matching document, removes it, passing the found document (if any) to the * callback. Executes immediately if callback is passed. * * If mongoose option 'useFindAndModify': set to false it uses native findOneAndUpdate() rather than deprecated findAndModify(). * https://mongoosejs.com/docs/api.html#mongoose_Mongoose-set */ findOneAndRemove(callback?: (error: any, doc: DocType | null, result: any) => void): DocumentQuery<DocType | null, DocType> & QueryHelpers; findOneAndRemove(conditions: any, callback?: (error: any, doc: DocType | null, result: any) => void): DocumentQuery<DocType | null, DocType> & QueryHelpers; findOneAndRemove(conditions: any, options: { rawResult: true } & QueryFindOneAndRemoveOptions, callback?: (error: any, doc: mongodb.FindAndModifyWriteOpResultObject<DocType | null>, result: any) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<DocType | null>> & QueryHelpers; findOneAndRemove(conditions: any, options: QueryFindOneAndRemoveOptions, callback?: (error: any, doc: DocType | null, result: any) => void): DocumentQuery<DocType | null, DocType> & QueryHelpers; /** * Issues a mongodb findAndModify update command. * Finds a matching document, updates it according to the update arg, passing any options, and returns * the found document (if any) to the callback. The query executes immediately if callback is passed. * * If mongoose option 'useFindAndModify': set to false it uses native findOneAndUpdate() rather than deprecated findAndModify(). * https://mongoosejs.com/docs/api.html#mongoose_Mongoose-set */ findOneAndUpdate(callback?: (err: any, doc: DocType | null) => void): DocumentQuery<DocType | null, DocType> & QueryHelpers; findOneAndUpdate(update: any, callback?: (err: any, doc: DocType | null, res: any) => void): DocumentQuery<DocType | null, DocType> & QueryHelpers; findOneAndUpdate(query: any, update: any, callback?: (err: any, doc: DocType | null, res: any) => void): DocumentQuery<DocType | null, DocType> & QueryHelpers; findOneAndUpdate(query: any, update: any, options: { rawResult: true } & { upsert: true } & { new: true } & QueryFindOneAndUpdateOptions, callback?: (err: any, doc: mongodb.FindAndModifyWriteOpResultObject<DocType>, res: any) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<DocType>> & QueryHelpers; findOneAndUpdate(query: any, update: any, options: { upsert: true } & { new: true } & QueryFindOneAndUpdateOptions, callback?: (err: any, doc: DocType, res: any) => void): DocumentQuery<DocType, DocType> & QueryHelpers; findOneAndUpdate(query: any, update: any, options: { rawResult: true } & QueryFindOneAndUpdateOptions, callback?: (err: any, doc: mongodb.FindAndModifyWriteOpResultObject<DocType | null>, res: any) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<DocType | null>> & QueryHelpers; findOneAndUpdate(query: any, update: any, options: QueryFindOneAndUpdateOptions, callback?: (err: any, doc: DocType | null, res: any) => void): DocumentQuery<DocType | null, DocType> & QueryHelpers; /** * Specifies a $geometry condition. geometry() must come after either intersects() or within(). * @param object Must contain a type property which is a String and a coordinates property which * is an Array. See the examples. */ geometry(object: { type: string, coordinates: any[] }): this; /** * Returns the current query options as a JSON object. * @returns current query options */ getOptions(): any; /** * Returns the current query conditions as a JSON object. * @returns current query conditions */ getQuery(): any; /** * Returns the current update operations as a JSON object. * @returns current update operations */ getUpdate(): any; /** * Specifies a $gt query condition. * When called with one argument, the most recent path passed to where() is used. */ gt<T>(val: T): this; gt<T>(path: string, val: T): this; /** * Specifies a $gte query condition. * When called with one argument, the most recent path passed to where() is used. */ gte<T>(val: T): this; gte<T>(path: string, val: T): this; /** * Sets query hints. * @param val a hint object */ hint(val: any): this; /** * Specifies an $in query condition. * When called with one argument, the most recent path passed to where() is used. */ in(val: any[]): this; in(path: string, val: any[]): this; /** Declares an intersects query for geometry(). MUST be used after where(). */ intersects(arg?: any): this; /** * Sets the lean option. * Documents returned from queries with the lean option enabled are plain * javascript objects, not MongooseDocuments. They have no save method, * getters/setters or other Mongoose magic applied. * @param {Boolean|Object} bool defaults to true */ lean(bool?: boolean | object): Query<any> & QueryHelpers; /** Specifies the maximum number of documents the query will return. Cannot be used with distinct() */ limit(val: number): this; /** * Specifies a $lt query condition. * When called with one argument, the most recent path passed to where() is used. */ lt<T>(val: T): this; lt<T>(path: string, val: T): this; /** * Specifies a $lte query condition. * When called with one argument, the most recent path passed to where() is used. */ lte<T>(val: T): this; lte<T>(path: string, val: T): this; /** * Specifies a $maxDistance query condition. * When called with one argument, the most recent path passed to where() is used. */ maxDistance(val: number): this; maxDistance(path: string, val: number): this; /** @deprecated Alias of maxScan */ maxscan(val: number): this; /** Specifies the maxScan option. Cannot be used with distinct() */ maxScan(val: number): this; /** Specifies the maxTimeMS options. */ maxTimeMS(val: number): this; /** * Merges another Query or conditions object into this one. * When a Query is passed, conditions, field selection and options are merged. */ merge(source: any | Query<any>): this; /** Specifies a $mod condition */ mod(val: number[]): this; mod(path: string, val: number[]): this; /** * Specifies a $ne query condition. * When called with one argument, the most recent path passed to where() is used. */ ne(val: any): this; ne(path: string, val: any): this; /** Specifies a $near or $nearSphere condition. */ near(val: any): this; near(path: string, val: any): this; /** * DEPRECATED Specifies a $nearSphere condition * @deprecated Use query.near() instead with the spherical option set to true. */ nearSphere(val: any): this; nearSphere(path: string, val: any): this; /** * Specifies a $nin query condition. * When called with one argument, the most recent path passed to where() is used. */ nin(val: any[]): this; nin(path: string, val: any[]): this; /** * Specifies arguments for a $nor condition. * @param array array of conditions */ nor(array: any[]): this; /** * Specifies arguments for an $or condition. * @param array array of conditions */ or(array: any[]): this; /** * Make this query throw an error if no documents match the given `filter`. * This is handy for integrating with async/await, because `orFail()` saves you * an extra `if` statement to check if no document was found. * * Example: * * // Throws if no doc returned * await Model.findOne({ foo: 'bar' }).orFail(); * * // Throws if no document was updated * await Model.updateOne({ foo: 'bar' }, { name: 'test' }).orFail(); * * // Throws "No docs found!" error if no docs match `{ foo: 'bar' }` * await Model.find({ foo: 'bar' }).orFail(new Error('No docs found!')); * * // Throws "Not found" error if no document was found * await Model.findOneAndUpdate({ foo: 'bar' }, { name: 'test' }). * orFail(() => Error('Not found')); * * @param err optional error to throw if no docs match `filter` */ orFail(err?: Error | (() => Error)): this; /** Specifies a $polygon condition */ polygon(...coordinatePairs: number[][]): this; polygon(path: string, ...coordinatePairs: number[][]): this; /** * Specifies paths which should be populated with other documents. * Paths are populated after the query executes and a response is received. A separate * query is then executed for each path specified for population. After a response for * each query has also been returned, the results are passed to the callback. * @param path either the path to populate or an object specifying all parameters * @param select Field selection for the population query * @param model The model you wish to use for population. If not specified, populate * will look up the model by the name in the Schema's ref field. * @param match Conditions for the population query * @param options Options for the population query (sort, etc) */ populate(path: string | any, select?: string | any, model?: any, match?: any, options?: any): this; populate(options: QueryPopulateOptions | QueryPopulateOptions[]): this; /** * Determines the MongoDB nodes from which to read. * @param pref one of the listed preference options or aliases * @tags optional tags for this query */ read(pref: string, tags?: any[]): this; /** * Sets the readConcern option for the query. * @param level one of the listed read concern level or their aliases */ readConcern(level: string): this; /** * Specifies a $regex query condition. * When called with one argument, the most recent path passed to where() is used. */ regex(val: RegExp): this; regex(path: string, val: RegExp): this; /** * Declare and/or execute this query as a remove() operation. * The operation is only executed when a callback is passed. To force execution without a callback, * you must first call remove() and then execute it by using the exec() method. * @param criteria mongodb selector */ remove(callback?: (err: any) => void): Query<mongodb.WriteOpResult['result']> & QueryHelpers; remove(criteria: any | Query<any>, callback?: (err: any) => void): Query<mongodb.WriteOpResult['result']> & QueryHelpers; /** Specifies which document fields to include or exclude (also known as the query "projection") */ select(arg: string | any): this; /** Determines if field selection has been made. */ selected(): boolean; /** Determines if exclusive field selection has been made.*/ selectedExclusively(): boolean; /** Determines if inclusive field selection has been made. */ selectedInclusively(): boolean; /** Sets query options. */ setOptions(options: any): this; /** Sets query conditions to the provided JSON object. */ setQuery(conditions: any): this; /** * Sets the [MongoDB session](https://docs.mongodb.com/manual/reference/server-sessions/) * associated with this query. Sessions are how you mark a query as part of a * [transaction](/docs/transactions.html). */ session(session: mongodb.ClientSession | null): this; /** * Specifies a $size query condition. * When called with one argument, the most recent path passed to where() is used. */ size(val: number): this; size(path: string, val: number): this; /** Specifies the number of documents to skip. Cannot be used with distinct() */ skip(val: number): this; /** * DEPRECATED Sets the slaveOk option. * @param v defaults to true * @deprecated in MongoDB 2.2 in favor of read preferences. */ slaveOk(v?: boolean): this; /** * Specifies a $slice projection for an array. * @param val number/range of elements to slice */ slice(val: number | number[]): this; slice(path: string, val: number | number[]): this; /** Specifies this query as a snapshot query. Cannot be used with distinct() */ snapshot(v?: boolean): this; /** * Sets the sort order * If an object is passed, values allowed are asc, desc, ascending, descending, 1, and -1. * If a string is passed, it must be a space delimited list of path names. The * sort order of each path is ascending unless the path name is prefixed with - * which will be treated as descending. */ sort(arg: string | any): this; /** * Sets the tailable option (for use with capped collections). Cannot be used with distinct() * @param bool defaults to true * @param opts options to set * @param opts.numberOfRetries if cursor is exhausted, retry this many times before giving up * @param opts.tailableRetryInterval if cursor is exhausted, wait this many milliseconds before retrying */ tailable(bool?: boolean, opts?: { numberOfRetries?: number; tailableRetryInterval?: number; }): this; /** Executes this query and returns a promise */ then: Promise<T>["then"]; /** * Converts this query to a customized, reusable query * constructor with all arguments and options retained. */ toConstructor<T>(): new (...args: any[]) => Query<T> & QueryHelpers; toConstructor<T, Doc extends Document>(): new (...args: any[]) => DocumentQuery<T, Doc> & QueryHelpers; /** * Declare and/or execute this query as an update() operation. * All paths passed that are not $atomic operations will become $set ops. * @param doc the update command */ update(callback?: (err: any, affectedRows: number) => void): Query<number> & QueryHelpers; update(doc: any, callback?: (err: any, affectedRows: number) => void): Query<number> & QueryHelpers; update(criteria: any, doc: any, callback?: (err: any, affectedRows: number) => void): Query<number> & QueryHelpers; update(criteria: any, doc: any, options: QueryUpdateOptions, callback?: (err: any, affectedRows: number) => void): Query<number> & QueryHelpers; /** Specifies a path for use with chaining. */ where(path?: string | any, val?: any): this; /** Defines a $within or $geoWithin argument for geo-spatial queries. */ within(val?: any): this; within(coordinate: number[], ...coordinatePairs: number[][]): this; /** Flag to opt out of using $geoWithin. */ static use$geoWithin: boolean; } // https://github.com/aheckmann/mquery // mquery currently does not have a type definition please // replace it if one is ever created class mquery { } interface QueryFindOneAndRemoveOptions { /** * if multiple docs are found by the conditions, sets the sort order to choose * which doc to update */ sort?: any; /** puts a time limit on the query - requires mongodb >= 2.6.0 */ maxTimeMS?: number; /** sets the document fields to return */ select?: any; /** like select, it determines which fields to return */ projection?: any; /** if true, returns the raw result from the MongoDB driver */ rawResult?: boolean; /** overwrites the schema's strict mode option for this update */ strict?: boolean|string; } interface QueryFindOneAndUpdateOptions extends QueryFindOneAndRemoveOptions { /** if true, return the modified document rather than the original. defaults to false (changed in 4.0) */ new?: boolean; /** creates the object if it doesn't exist. defaults to false. */ upsert?: boolean; /** if true, runs update validators on this command. Update validators validate the update operation against the model's schema. */ runValidators?: boolean; /** * if this and upsert are true, mongoose will apply the defaults specified in the model's schema if a new document * is created. This option only works on MongoDB >= 2.4 because it relies on MongoDB's $setOnInsert operator. */ setDefaultsOnInsert?: boolean; /** * if set to 'query' and runValidators is on, this will refer to the query in custom validator * functions that update validation runs. Does nothing if runValidators is false. */ context?: string; /** * by default, mongoose only returns the first error that occurred in casting the query. * Turn on this option to aggregate all the cast errors. */ multipleCastError?: boolean; /** Field selection. Equivalent to .select(fields).findOneAndUpdate() */ fields?: any | string; } interface QueryUpdateOptions extends ModelUpdateOptions { /** * if set to 'query' and runValidators is on, this will refer to the query * in customvalidator functions that update validation runs. Does nothing * if runValidators is false. */ context?: string; } interface CollationOptions { locale?: string; caseLevel?: boolean; caseFirst?: string; strength?: number; numericOrdering?: boolean; alternate?: string; maxVariable?: string; backwards?: boolean; } namespace Schema { namespace Types { /* * section schema/array.js * http://mongoosejs.com/docs/api.html#schema-array-js */ class Array extends SchemaType { /** Array SchemaType constructor */ constructor(key: string, cast?: SchemaType, options?: any); /** * Check if the given value satisfies a required validator. The given value * must be not null nor undefined, and have a non-zero length. */ checkRequired<T extends { length: number }>(value: T): boolean; /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } /* * section schema/string.js * http://mongoosejs.com/docs/api.html#schema-string-js */ class String extends SchemaType { /** String SchemaType constructor. */ constructor(key: string, options?: any); /** Check if the given value satisfies a required validator. */ checkRequired(value: any, doc: MongooseDocument): boolean; /** * Adds an enum validator * @param args enumeration values */ enum(args: string | string[] | any): this; /** Adds a lowercase setter. */ lowercase(): this; /** * Sets a regexp validator. Any value that does not pass regExp.test(val) will fail validation. * @param regExp regular expression to test against * @param message optional custom error message */ match(regExp: RegExp, message?: string): this; /** * Sets a maximum length validator. * @param value maximum string length * @param message optional custom error message */ maxlength(value: number, message?: string): this; /** * Sets a minimum length validator. * @param value minimum string length * @param message optional custom error message */ minlength(value: number, message?: string): this; /** Adds a trim setter. The string value will be trimmed when set. */ trim(): this; /** Adds an uppercase setter. */ uppercase(): this; /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } /* * section schema/documentarray.js * http://mongoosejs.com/docs/api.html#schema-documentarray-js */ class DocumentArray extends Array { /** SubdocsArray SchemaType constructor */ constructor(key: string, schema: Schema, options?: any); /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; /** * Adds a discriminator type. * @param name discriminator model name * @param schema discriminator model schema */ discriminator<U extends Document>(name: string, schema: Schema): Model<U>; /** * Adds a discriminator type. * @param name discriminator model name * @param schema discriminator model schema */ discriminator<U extends Document, M extends Model<U>>(name: string, schema: Schema): M; } /* * section schema/number.js * http://mongoosejs.com/docs/api.html#schema-number-js */ class Number extends SchemaType { /** Number SchemaType constructor. */ constructor(key: string, options?: any); /** Check if the given value satisfies a required validator. */ checkRequired(value: any, doc: MongooseDocument): boolean; /** * Sets a maximum number validator. * @param maximum number * @param message optional custom error message */ max(maximum: number, message?: string): this; /** * Sets a minimum number validator. * @param value minimum number * @param message optional custom error message */ min(value: number, message?: string): this; /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } /* * section schema/date.js * http://mongoosejs.com/docs/api.html#schema-date-js */ class Date extends SchemaType { /** Date SchemaType constructor. */ constructor(key: string, options?: any); /** * Check if the given value satisfies a required validator. To satisfy * a required validator, the given value must be an instance of Date. */ checkRequired(value: any, doc: MongooseDocument): boolean; /** Declares a TTL index (rounded to the nearest second) for Date types only. */ expires(when: number | string): this; /** * Sets a maximum date validator. * @param maximum date * @param message optional custom error message */ max(maximum: NativeDate, message?: string): this; /** * Sets a minimum date validator. * @param value minimum date * @param message optional custom error message */ min(value: NativeDate, message?: string): this; /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } /* * section schema/buffer.js * http://mongoosejs.com/docs/api.html#schema-buffer-js */ class Buffer extends SchemaType { /** Buffer SchemaType constructor */ constructor(key: string, options?: any); /** * Check if the given value satisfies a required validator. To satisfy a * required validator, a buffer must not be null or undefined and have * non-zero length. */ checkRequired(value: any, doc: MongooseDocument): boolean; /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } /* * section schema/boolean.js * http://mongoosejs.com/docs/api.html#schema-boolean-js */ class Boolean extends SchemaType { /** Boolean SchemaType constructor. */ constructor(path: string, options?: any); /** * Check if the given value satisfies a required validator. For a * boolean to satisfy a required validator, it must be strictly * equal to true or to false. */ checkRequired(value: any): boolean; /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } /* * section schema/objectid.js * http://mongoosejs.com/docs/api.html#schema-objectid-js */ class ObjectId extends SchemaType { /** ObjectId SchemaType constructor. */ constructor(key: string, options?: any); /** * Adds an auto-generated ObjectId default if turnOn is true. * @param turnOn auto generated ObjectId defaults */ auto(turnOn: boolean): this; /** Check if the given value satisfies a required validator. */ checkRequired(value: any, doc: MongooseDocument): boolean; /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } /* * section schema/decimal128.js * http://mongoosejs.com/docs/api.html#schema-decimal128-js */ class Decimal128 extends SchemaType { /** Decimal128 SchemaType constructor. */ constructor(key: string, options?: any); /** Check if the given value satisfies a required validator. */ checkRequired(value: any, doc: MongooseDocument): boolean; /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } /* * section schema/mixed.js * http://mongoosejs.com/docs/api.html#schema-mixed-js */ class Mixed extends SchemaType { /** Mixed SchemaType constructor. */ constructor(path: string, options?: any); /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } /* * section schema/embedded.js * http://mongoosejs.com/docs/api.html#schema-embedded-js */ class Embedded extends SchemaType { /** Sub-schema schematype constructor */ constructor(schema: Schema, key: string, options?: any); } } } /* * section aggregate.js * http://mongoosejs.com/docs/api.html#aggregate-js */ class Aggregate<T> { /** * Aggregate constructor used for building aggregation pipelines. * Returned when calling Model.aggregate(). * @param ops aggregation operator(s) or operator array */ constructor(ops?: any | any[], ...args: any[]); /** Adds a cursor flag */ addCursorFlag(flag: string, value: boolean): this; /** * Appends a new $addFields operator to this aggregate pipeline. Requires MongoDB v3.4+ to work * @param arg field specification */ addFields(arg: any): this; /** * Sets the allowDiskUse option for the aggregation query (ignored for < 2.6.0) * @param value Should tell server it can use hard drive to store data during aggregation. * @param tags optional tags for this query */ allowDiskUse(value: boolean, tags?: any[]): this; /** * Appends new operators to this aggregate pipeline * @param ops operator(s) to append */ append(...ops: any[]): this; /** Adds a collation. */ collation(options: CollationOptions): this; /** * Appends a new $count operator to this aggregate pipeline. * @param countName name of the count field */ count(countName: string): this; /** * Sets the cursor option option for the aggregation query (ignored for < 2.6.0). * Note the different syntax below: .exec() returns a cursor object, and no callback * is necessary. * @param options set the cursor batch size */ cursor(options: any): this; /** * Appends a new $facet operator to this aggregate pipeline. * @param arg $facet operator contents */ facet(arg: { [outputField: string]: object[] }): this; // If cursor option is on, could return an object /** Executes the aggregate pipeline on the currently bound Model. */ exec(callback?: (err: any, result: T) => void): Promise<T> | any; /** Execute the aggregation with explain */ explain(callback?: (err: any, result: T) => void): Promise<T>; /** * Appends a new custom $group operator to this aggregate pipeline. * @param arg $group operator contents */ group(arg: any): this; /** * Appends a new $limit operator to this aggregate pipeline. * @param num maximum number of records to pass to the next stage */ limit(num: number): this; /** * Appends new custom $lookup operator(s) to this aggregate pipeline. * @param options to $lookup as described in the above link */ lookup(options: any): this; /** * Appends a new custom $match operator to this aggregate pipeline. * @param arg $match operator contents */ match(arg: any): this; /** * Binds this aggregate to a model. * @param model the model to which the aggregate is to be bound */ model(model: any): this; /** * Appends new custom $graphLookup operator(s) to this aggregate pipeline, performing a recursive search on a collection. * Note that graphLookup can only consume at most 100MB of memory, and does not allow disk use even if { allowDiskUse: true } is specified. * @param options options to $graphLookup */ graphLookup(options: any): this; /** * Appends a new $geoNear operator to this aggregate pipeline. * MUST be used as the first operator in the pipeline. */ near(parameters: any): this; /** * Lets you set arbitrary options, for middleware or plugins. * @param value keys to merge into current options */ option(value: any): this; /** Returns the current pipeline */ pipeline(): any[]; /** * Appends a new $project operator to this aggregate pipeline. * Mongoose query selection syntax is also supported. * @param arg field specification */ project(arg: string | any): this; /** * Sets the readPreference option for the aggregation query. * @param pref one of the listed preference options or their aliases * @param tags optional tags for this query */ read(pref: string, tags?: any[]): this; /** * Appends a new $replaceRoot operator to this aggregate pipeline. * Note that the $replaceRoot operator requires field strings to start with '$'. If you are passing in a string Mongoose will prepend '$' if the specified field doesn't start '$'. If you are passing in an object the strings in your expression will not be altered. * @param newRoot field or document which will become the new root document */ replaceRoot(newRoot: string | object): this; /** * Appends new custom $sample operator(s) to this aggregate pipeline. * @param size number of random documents to pick */ sample(size: number): this; session(session: mongodb.ClientSession | null): this; /** * Appends a new $skip operator to this aggregate pipeline. * @param num number of records to skip before next stage */ skip(num: number): this; /** * Appends a new $sort operator to this aggregate pipeline. * If an object is passed, values allowed are asc, desc, ascending, descending, 1, and -1. * If a string is passed, it must be a space delimited list of path names. The sort order * of each path is ascending unless the path name is prefixed with - which will be treated * as descending. */ sort(arg: string | any): this; /** Provides promise for aggregate. */ then: Promise<T>["then"]; /** * Appends new custom $unwind operator(s) to this aggregate pipeline. * Note that the $unwind operator requires the path name to start with '$'. * Mongoose will prepend '$' if the specified field doesn't start '$'. * @param fields the field(s) to unwind */ unwind(...fields: string[]): this; /** * Appends new custom $unwind operator(s) to this aggregate pipeline * new in mongodb 3.2 */ unwind(...opts: { path: string, includeArrayIndex?: string, preserveNullAndEmptyArrays?: boolean }[]): this; } /* * section schematype.js * http://mongoosejs.com/docs/api.html#schematype-js */ class SchemaType { /** SchemaType constructor */ constructor(path: string, options?: any, instance?: string); /** * Sets a default value for this SchemaType. * Defaults can be either functions which return the value to use as the * default or the literal value itself. Either way, the value will be cast * based on its schema type before being set during document creation. * @param val the default value */ default(val: any): any; /** Adds a getter to this schematype. */ get(fn: Function): this; /** * Declares the index options for this schematype. * Indexes are created in the background by default. Specify background: false to override. */ index(options: any | boolean | string): this; /** * Adds a required validator to this SchemaType. The validator gets added * to the front of this SchemaType's validators array using unshift(). * @param required enable/disable the validator * @param message optional custom error message */ required(required: boolean, message?: string): this; /** Sets default select() behavior for this path. */ select(val: boolean): this; /** Adds a setter to this schematype. */ set(fn: Function): this; /** Declares a sparse index. */ sparse(bool: boolean): this; /** Declares a full text index. */ text(bool: boolean): this; /** Declares an unique index. */ unique(bool: boolean): this; /** * Adds validator(s) for this document path. * Validators always receive the value to validate as their first argument * and must return Boolean. Returning false means validation failed. * @param obj validator * @param errorMsg optional error message * @param type optional validator type */ validate(obj: RegExp | Function | any, errorMsg?: string, type?: string): this; } /* * section promise.js * http://mongoosejs.com/docs/api.html#promise-js */ /** * To assign your own promise library: * * 1. Typescript does not allow assigning properties of imported modules. * To avoid compile errors use one of the options below in your code: * * - (<any>mongoose).Promise = YOUR_PROMISE; * - require('mongoose').Promise = YOUR_PROMISE; * - import mongoose = require('mongoose'); * mongoose.Promise = YOUR_PROMISE; * * 2. To assign type definitions for your promise library, you will need * to have a .d.ts file with the following code when you compile: * * - import * as Q from 'q'; * declare module 'mongoose' { * type Promise<T> = Q.promise<T>; * } * * - import * as Bluebird from 'bluebird'; * declare module 'mongoose' { * type Promise<T> = Bluebird<T>; * } * * Uses global.Promise by default. If you would like to use mongoose default * mpromise implementation (which is deprecated), you can omit step 1 and * run npm install @types/mongoose-promise */ export var Promise: any; export var PromiseProvider: any; /* * section model.js * http://mongoosejs.com/docs/api.html#model-js */ export var Model: Model<any>; interface Model<T extends Document, QueryHelpers = {}> extends NodeJS.EventEmitter, ModelProperties { /** * Model constructor * Provides the interface to MongoDB collections as well as creates document instances. * @param doc values with which to create the document * @event error If listening to this event, it is emitted when a document * was saved without passing a callback and an error occurred. If not * listening, the event bubbles to the connection used to create this Model. * @event index Emitted after Model#ensureIndexes completes. If an error * occurred it is passed with the event. * @event index-single-start Emitted when an individual index starts within * Model#ensureIndexes. The fields and options being used to build the index * are also passed with the event. * @event index-single-done Emitted when an individual index finishes within * Model#ensureIndexes. If an error occurred it is passed with the event. * The fields, options, and index name are also passed. */ new(doc?: DeepPartial<T>): T; /** * Requires a replica set running MongoDB >= 3.6.0. Watches the underlying collection for changes using MongoDB change streams. * This function does not trigger any middleware. In particular, it does not trigger aggregate middleware. * @param options See https://mongodb.github.io/node-mongodb-native/3.0/api/Collection.html#watch */ watch(options?: mongodb.ChangeStreamOptions & { session?: ClientSession }): mongodb.ChangeStream; /** * Translate any aliases fields/conditions so the final query or document object is pure * @param raw fields/conditions that may contain aliased keys * @return the translated 'pure' fields/conditions */ translateAliases(raw: any): any; /** * Sends multiple insertOne, updateOne, updateMany, replaceOne, deleteOne, and/or deleteMany operations to the MongoDB server in one command. This is faster than sending multiple independent operations (like) if you use create()) because with bulkWrite() there is only one round trip to MongoDB. * Mongoose will perform casting on all operations you provide. * This function does not trigger any middleware, not save() nor update(). If you need to trigger save() middleware for every document use create() instead. * @param writes Operations * @param cb callback * @return `BulkWriteOpResult` if the operation succeeds */ bulkWrite(writes: any[], cb?: (err: any, res: mongodb.BulkWriteOpResultObject) => void): Promise<mongodb.BulkWriteOpResultObject>; /** * Finds a single document by its _id field. findById(id) is almost* * equivalent to findOne({ _id: id }). findById() triggers findOne hooks. * @param id value of _id to query by * @param projection optional fields to return */ findById(id: any | string | number, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; findById(id: any | string | number, projection: any, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; findById(id: any | string | number, projection: any, options: any, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; model<U extends Document>(name: string): Model<U>; /** * Creates a Query and specifies a $where condition. * @param argument is a javascript string or anonymous function */ $where(argument: string | Function): DocumentQuery<T, T> & QueryHelpers; /** * Performs aggregations on the models collection. * If a callback is passed, the aggregate is executed and a Promise is returned. * If a callback is not passed, the aggregate itself is returned. * @param aggregations pipeline operator(s) or operator array */ aggregate(aggregations?: any[]): Aggregate<any[]>; aggregate(aggregations: any[], cb: Function): Promise<any[]>; /** Counts number of matching documents in a database collection. */ count(conditions: any, callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; /** * Counts number of documents matching `criteria` in a database collection. * * If you want to count all documents in a large collection, * use the `estimatedDocumentCount()` instead. * If you call `countDocuments({})`, MongoDB will always execute * a full collection scan and **not** use any indexes. * * @param {Object} filter * @param {Function} [callback] * @return {Query} */ countDocuments(callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; countDocuments(criteria: any, callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; /** * Estimates the number of documents in the MongoDB collection. Faster than * using `countDocuments()` for large collections because * `estimatedDocumentCount()` uses collection metadata rather than scanning * the entire collection. * * @param {Object} [options] * @param {Function} [callback] * @return {Query} */ estimatedDocumentCount(callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; estimatedDocumentCount(options: any, callback?: (err: any, count: number) => void): Query<number> & QueryHelpers; /** * Shortcut for saving one or more documents to the database. MyModel.create(docs) * does new MyModel(doc).save() for every doc in docs. * Triggers the save() hook. */ create(docs: any[], callback?: (err: any, res: T[]) => void): Promise<T[]>; create(docs: any[], options?: SaveOptions, callback?: (err: any, res: T[]) => void): Promise<T[]>; create(...docs: any[]): Promise<T>; create(...docsWithCallback: any[]): Promise<T>; /** * Create the collection for this model. By default, if no indexes are specified, mongoose will not create the * collection for the model until any documents are created. Use this method to create the collection explicitly. */ createCollection(options?: mongodb.CollectionCreateOptions, cb?: (err: any) => void): Promise<void>; /** * Adds a discriminator type. * @param name discriminator model name * @param schema discriminator model schema */ discriminator<U extends Document>(name: string, schema: Schema): Model<U>; /** * Adds a discriminator type. * @param name discriminator model name * @param schema discriminator model schema */ discriminator<U extends Document, M extends Model<U>>(name: string, schema: Schema): M; /** Creates a Query for a distinct operation. Passing a callback immediately executes the query. */ distinct(field: string, callback?: (err: any, res: any[]) => void): Query<any[]> & QueryHelpers; distinct(field: string, conditions: any, callback?: (err: any, res: any[]) => void): Query<any[]> & QueryHelpers; /** * Makes the indexes in MongoDB match the indexes defined in this model's * schema. This function will drop any indexes that are not defined in * the model's schema except the `_id` index, and build any indexes that * are in your schema but not in MongoDB. * @param options options to pass to `ensureIndexes()` * @param callback optional callback * @return Returns `undefined` if callback is specified, returns a promise if no callback. */ syncIndexes(options: object, callback?: (err: any) => void): void; syncIndexes(options: object): Promise<void>; /** * Lists the indexes currently defined in MongoDB. This may or may not be * the same as the indexes defined in your schema depending on whether you * use the [`autoIndex` option](/docs/guide.html#autoIndex) and if you * build indexes manually. * @param cb optional callback * @return Returns `undefined` if callback is specified, returns a promise if no callback. */ listIndexes(callback: (err: any) => void): void; listIndexes(): Promise<void>; /** * Sends ensureIndex commands to mongo for each index declared in the schema. * @param options internal options * @param cb optional callback */ ensureIndexes(callback?: (err: any) => void): Promise<void>; ensureIndexes(options: any, callback?: (err: any) => void): Promise<void>; /** * Similar to ensureIndexes(), except for it uses the createIndex function. The ensureIndex() function checks to see if an index with that name already exists, and, if not, does not attempt to create the index. createIndex() bypasses this check. * @param cb Optional callback */ createIndexes(cb?: (err: any) => void): Promise<void>; /** * Finds documents. * @param projection optional fields to return */ find(callback?: (err: any, res: T[]) => void): DocumentQuery<T[], T> & QueryHelpers; find(conditions: any, callback?: (err: any, res: T[]) => void): DocumentQuery<T[], T> & QueryHelpers; find(conditions: any, projection?: any | null, callback?: (err: any, res: T[]) => void): DocumentQuery<T[], T> & QueryHelpers; find(conditions: any, projection?: any | null, options?: any | null, callback?: (err: any, res: T[]) => void): DocumentQuery<T[], T> & QueryHelpers; /** * Issue a mongodb findAndModify remove command by a document's _id field. * findByIdAndRemove(id, ...) is equivalent to findOneAndRemove({ _id: id }, ...). * Finds a matching document, removes it, passing the found document (if any) to the callback. * Executes immediately if callback is passed, else a Query object is returned. * * If mongoose option 'useFindAndModify': set to false it uses native findOneAndUpdate() rather than deprecated findAndModify(). * https://mongoosejs.com/docs/api.html#mongoose_Mongoose-set * * Note: same signatures as findByIdAndDelete * * @param id value of _id to query by */ findByIdAndRemove(): DocumentQuery<T | null, T> & QueryHelpers; findByIdAndRemove(id: any | number | string, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; findByIdAndRemove(id: any | number | string, options: QueryFindOneAndRemoveOptions, callback?: (err: any, res: mongodb.FindAndModifyWriteOpResultObject<T | null>) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<T | null>> & QueryHelpers; findByIdAndRemove(id: any | number | string, options: QueryFindOneAndRemoveOptions, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; /** * Issue a mongodb findOneAndDelete command by a document's _id field. * findByIdAndDelete(id, ...) is equivalent to findByIdAndDelete({ _id: id }, ...). * Finds a matching document, removes it, passing the found document (if any) to the callback. * Executes immediately if callback is passed, else a Query object is returned. * * Note: same signatures as findByIdAndRemove * * @param id value of _id to query by */ findByIdAndDelete(): DocumentQuery<T | null, T> & QueryHelpers; findByIdAndDelete(id: any | number | string, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; findByIdAndDelete(id: any | number | string, options: QueryFindOneAndRemoveOptions, callback?: (err: any, res: mongodb.FindAndModifyWriteOpResultObject<T | null>) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<T | null>> & QueryHelpers; findByIdAndDelete(id: any | number | string, options: QueryFindOneAndRemoveOptions, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; /** * Issues a mongodb findAndModify update command by a document's _id field. findByIdAndUpdate(id, ...) * is equivalent to findOneAndUpdate({ _id: id }, ...). * * If mongoose option 'useFindAndModify': set to false it uses native findOneAndUpdate() rather than deprecated findAndModify(). * https://mongoosejs.com/docs/api.html#mongoose_Mongoose-set * * @param id value of _id to query by */ findByIdAndUpdate(): DocumentQuery<T | null, T> & QueryHelpers; findByIdAndUpdate(id: any | number | string, update: any, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; findByIdAndUpdate(id: any | number | string, update: any, options: { rawResult: true } & { upsert: true } & { new: true } & QueryFindOneAndUpdateOptions, callback?: (err: any, res: T) => void): DocumentQuery<T, T> & QueryHelpers; findByIdAndUpdate(id: any | number | string, update: any, options: { upsert: true, new: true } & QueryFindOneAndUpdateOptions, callback?: (err: any, res: mongodb.FindAndModifyWriteOpResultObject<T>) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<T>> & QueryHelpers; findByIdAndUpdate(id: any | number | string, update: any, options: { rawResult : true } & QueryFindOneAndUpdateOptions, callback?: (err: any, res: mongodb.FindAndModifyWriteOpResultObject<T | null>) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<T | null>> & QueryHelpers; findByIdAndUpdate(id: any | number | string, update: any, options: QueryFindOneAndUpdateOptions, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; /** * Finds one document. * The conditions are cast to their respective SchemaTypes before the command is sent. * @param projection optional fields to return */ findOne(conditions?: any, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; findOne(conditions: any, projection: any, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; findOne(conditions: any, projection: any, options: any, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; /** * Issue a mongodb findAndModify remove command. * Finds a matching document, removes it, passing the found document (if any) to the callback. * Executes immediately if callback is passed else a Query object is returned. * * If mongoose option 'useFindAndModify': set to false it uses native findOneAndUpdate() rather than deprecated findAndModify(). * https://mongoosejs.com/docs/api.html#mongoose_Mongoose-set * * Note: same signatures as findOneAndDelete * */ findOneAndRemove(): DocumentQuery<T | null, T> & QueryHelpers; findOneAndRemove(conditions: any, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; findOneAndRemove(conditions: any, options: { rawResult: true } & QueryFindOneAndRemoveOptions, callback?: (err: any, doc: mongodb.FindAndModifyWriteOpResultObject<T | null>, res: any) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<T | null>> & QueryHelpers; findOneAndRemove(conditions: any, options: QueryFindOneAndRemoveOptions, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; /** * Issues a mongodb findOneAndDelete command. * Finds a matching document, removes it, passing the found document (if any) to the * callback. Executes immediately if callback is passed. * * Note: same signatures as findOneAndRemove * */ findOneAndDelete(): DocumentQuery<T | null, T> & QueryHelpers; findOneAndDelete(conditions: any, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; findOneAndDelete(conditions: any, options: { rawResult: true } & QueryFindOneAndRemoveOptions, callback?: (err: any, doc: mongodb.FindAndModifyWriteOpResultObject<T | null>, res: any) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<T | null>> & QueryHelpers; findOneAndDelete(conditions: any, options: QueryFindOneAndRemoveOptions, callback?: (err: any, res: T | null) => void): DocumentQuery<T | null, T> & QueryHelpers; /** * Issues a mongodb findAndModify update command. * Finds a matching document, updates it according to the update arg, passing any options, * and returns the found document (if any) to the callback. The query executes immediately * if callback is passed else a Query object is returned. * + * If mongoose option 'useFindAndModify': set to false it uses native findOneAndUpdate() rather than the deprecated findAndModify(). + * https://mongoosejs.com/docs/api.html#mongoose_Mongoose-set */ findOneAndUpdate(): DocumentQuery<T | null, T> & QueryHelpers; findOneAndUpdate(conditions: any, update: any, callback?: (err: any, doc: T | null, res: any) => void): DocumentQuery<T | null, T> & QueryHelpers; findOneAndUpdate(conditions: any, update: any, options: { rawResult : true } & { upsert: true, new: true } & QueryFindOneAndUpdateOptions, callback?: (err: any, doc: mongodb.FindAndModifyWriteOpResultObject<T>, res: any) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<T>> & QueryHelpers; findOneAndUpdate(conditions: any, update: any, options: { upsert: true, new: true } & QueryFindOneAndUpdateOptions, callback?: (err: any, doc: T, res: any) => void): DocumentQuery<T, T> & QueryHelpers; findOneAndUpdate(conditions: any, update: any, options: { rawResult: true } & QueryFindOneAndUpdateOptions, callback?: (err: any, doc: mongodb.FindAndModifyWriteOpResultObject<T | null>, res: any) => void) : Query<mongodb.FindAndModifyWriteOpResultObject<T | null>> & QueryHelpers; findOneAndUpdate(conditions: any, update: any, options: QueryFindOneAndUpdateOptions, callback?: (err: any, doc: T | null, res: any) => void): DocumentQuery<T | null, T> & QueryHelpers; /** * Implements $geoSearch functionality for Mongoose * @param conditions an object that specifies the match condition (required) * @param options for the geoSearch, some (near, maxDistance) are required * @param callback optional callback */ geoSearch(conditions: any, options: { /** x,y point to search for */ near: number[]; /** the maximum distance from the point near that a result can be */ maxDistance: number; /** The maximum number of results to return */ limit?: number; /** return the raw object instead of the Mongoose Model */ lean?: boolean; }, callback?: (err: any, res: T[]) => void): DocumentQuery<T[], T> & QueryHelpers; /** * Shortcut for creating a new Document from existing raw data, * pre-saved in the DB. The document returned has no paths marked * as modified initially. */ hydrate(obj: any): T; /** * Shortcut for validating an array of documents and inserting them into * MongoDB if they're all valid. This function is faster than .create() * because it only sends one operation to the server, rather than one for each * document. * This function does not trigger save middleware. * @param docs Documents to insert. * @param options Optional settings. * @param options.ordered if true, will fail fast on the first error encountered. * If false, will insert all the documents it can and report errors later. * @param options.rawResult if false, the returned promise resolves to the documents that passed mongoose document validation. * If `false`, will return the [raw result from the MongoDB driver](http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~insertWriteOpCallback) * with a `mongoose` property that contains `validationErrors` if this is an unordered `insertMany`. */ insertMany(docs: any[], callback?: (error: any, docs: T[]) => void): Promise<T[]>; insertMany(docs: any[], options?: { ordered?: boolean, rawResult?: boolean } & ModelOptions, callback?: (error: any, docs: T[]) => void): Promise<T[]>; insertMany(doc: any, callback?: (error: any, doc: T) => void): Promise<T>; insertMany(doc: any, options?: { ordered?: boolean, rawResult?: boolean } & ModelOptions, callback?: (error: any, doc: T) => void): Promise<T>; /** * Performs any async initialization of this model against MongoDB. * This function is called automatically, so you don't need to call it. * This function is also idempotent, so you may call it to get back a promise * that will resolve when your indexes are finished building as an alternative * to `MyModel.on('index')` * @param callback optional */ init(callback?: (err: any) => void): Promise<T>; /** * Executes a mapReduce command. * @param o an object specifying map-reduce options * @param callbackoptional callback */ mapReduce<Key, Value>( o: ModelMapReduceOption<T, Key, Value>, callback?: (err: any, res: any) => void ): Promise<any>; /** * Populates document references. * @param docs Either a single document or array of documents to populate. * @param options A hash of key/val (path, options) used for population. * @param callback Optional callback, executed upon completion. Receives err and the doc(s). */ populate(docs: any[], options: ModelPopulateOptions | ModelPopulateOptions[], callback?: (err: any, res: T[]) => void): Promise<T[]>; populate<T>(docs: any, options: ModelPopulateOptions | ModelPopulateOptions[], callback?: (err: any, res: T) => void): Promise<T>; /** Removes documents from the collection. */ remove(conditions: any, callback?: (err: any) => void): Query<mongodb.DeleteWriteOpResultObject['result']> & QueryHelpers; deleteOne(conditions: any, callback?: (err: any) => void): Query<mongodb.DeleteWriteOpResultObject['result']> & QueryHelpers; deleteMany(conditions: any, callback?: (err: any) => void): Query<mongodb.DeleteWriteOpResultObject['result']> & QueryHelpers; /** * Same as update(), except MongoDB replace the existing document with the given document (no atomic operators like $set). * This function triggers the following middleware: replaceOne */ replaceOne(conditions: any, replacement: any, callback?: (err: any, raw: any) => void): Query<any> & QueryHelpers; /** * Updates documents in the database without returning them. * All update values are cast to their appropriate SchemaTypes before being sent. */ update(conditions: any, doc: any, callback?: (err: any, raw: any) => void): Query<any> & QueryHelpers; update(conditions: any, doc: any, options: ModelUpdateOptions, callback?: (err: any, raw: any) => void): Query<any> & QueryHelpers; updateOne(conditions: any, doc: any, callback?: (err: any, raw: any) => void): Query<any> & QueryHelpers; updateOne(conditions: any, doc: any, options: ModelUpdateOptions, callback?: (err: any, raw: any) => void): Query<any> & QueryHelpers; updateMany(conditions: any, doc: any, callback?: (err: any, raw: any) => void): Query<any> & QueryHelpers; updateMany(conditions: any, doc: any, options: ModelUpdateOptions, callback?: (err: any, raw: any) => void): Query<any> & QueryHelpers; /** Creates a Query, applies the passed conditions, and returns the Query. */ where(path: string, val?: any): Query<any> & QueryHelpers; } interface Document extends MongooseDocument, NodeJS.EventEmitter, ModelProperties { /** Signal that we desire an increment of this documents version. */ increment(): this; /** * Returns another Model instance. * @param name model name */ model<T extends Document>(name: string): Model<T>; /** Override whether mongoose thinks this doc is deleted or not */ $isDeleted(isDeleted: boolean): void; /** whether mongoose thinks this doc is deleted. */ $isDeleted(): boolean; /** * Removes this document from the db. * @param fn optional callback */ remove(fn?: (err: any, product: this) => void): Promise<this>; /** * Saves this document. * @param options options optional options * @param options.safe overrides schema's safe option * @param options.validateBeforeSave set to false to save without validating. * @param fn optional callback */ save(options?: SaveOptions, fn?: (err: any, product: this) => void): Promise<this>; save(fn?: (err: any, product: this) => void): Promise<this>; /** * Version using default version key. See http://mongoosejs.com/docs/guide.html#versionKey * If you're using another key, you will have to access it using []: doc[_myVersionKey] */ __v?: number; } interface SaveOptions { safe?: boolean | WriteConcern; validateBeforeSave?: boolean; session?: ClientSession; } interface WriteConcern { j?: boolean; w?: number | 'majority' | TagSet; wtimeout?: number; } interface TagSet { [k: string]: string; } interface ModelProperties { /** Base Mongoose instance the model uses. */ base: typeof mongoose; /** * If this is a discriminator model, baseModelName is the * name of the base model. */ baseModelName: string | undefined; /** Collection the model uses. */ collection: Collection; /** Connection the model uses. */ db: Connection; /** Registered discriminators for this model. */ discriminators: any; /** The name of the model */ modelName: string; /** Schema the model uses. */ schema: Schema; } /** https://mongoosejs.com/docs/api.html#query_Query-setOptions */ interface ModelOptions { session?: ClientSession | null; } interface QueryPopulateOptions { /** space delimited path(s) to populate */ path: string; /** optional fields to select */ select?: any; /** optional query conditions to match */ match?: any; /** optional name of the model to use for population */ model?: string; /** optional query options like sort, limit, etc */ options?: any; /** deep populate */ populate?: QueryPopulateOptions | QueryPopulateOptions[]; } interface ModelPopulateOptions extends QueryPopulateOptions { /** optional, if true Mongoose will always set path to an array. Inferred from schema by default */ justOne?: boolean; } interface ModelUpdateOptions extends ModelOptions { /** safe mode (defaults to value set in schema (true)) */ safe?: boolean; /** whether to create the doc if it doesn't match (false) */ upsert?: boolean; /** whether multiple documents should be updated (false) */ multi?: boolean; /** * If true, runs update validators on this command. Update validators validate * the update operation against the model's schema. */ runValidators?: boolean; /** * If this and upsert are true, mongoose will apply the defaults specified in the * model's schema if a new document is created. This option only works on MongoDB >= 2.4 * because it relies on MongoDB's $setOnInsert operator. */ setDefaultsOnInsert?: boolean; /** overrides the strict option for this update */ strict?: boolean; /** disables update-only mode, allowing you to overwrite the doc (false) */ overwrite?: boolean; /** other options */ [other: string]: any; /** * by default, mongoose only returns the first error that occurred in casting the query. * Turn on this option to aggregate all the cast errors. */ multipleCastError?: boolean; } interface ModelMapReduceOption<T, Key, Val> { map: Function | string; reduce: (key: Key, vals: T[]) => Val; /** query filter object. */ query?: any; /** sort input objects using this key */ sort?: any; /** max number of documents */ limit?: number; /** keep temporary data default: false */ keeptemp?: boolean; /** finalize function */ finalize?: (key: Key, val: Val) => Val; /** scope variables exposed to map/reduce/finalize during execution */ scope?: any; /** it is possible to make the execution stay in JS. Provided in MongoDB > 2.0.X default: false */ jsMode?: boolean; /** provide statistics on job execution time. default: false */ verbose?: boolean; readPreference?: string; /** sets the output target for the map reduce job. default: {inline: 1} */ out?: { /** the results are returned in an array */ inline?: number; /** * {replace: 'collectionName'} add the results to collectionName: the * results replace the collection */ replace?: string; /** * {reduce: 'collectionName'} add the results to collectionName: if * dups are detected, uses the reducer / finalize functions */ reduce?: string; /** * {merge: 'collectionName'} add the results to collectionName: if * dups exist the new docs overwrite the old */ merge?: string; }; } interface MapReduceResult<Key, Val> { _id: Key; value: Val; } /* * section collection.js * http://mongoosejs.com/docs/api.html#collection-js */ interface CollectionBase extends mongodb.Collection { /* * Abstract methods. Some of these are already defined on the * mongodb.Collection interface so they've been commented out. */ ensureIndex(...args: any[]): any; //find(...args: any[]): any; findAndModify(...args: any[]): any; //findOne(...args: any[]): any; getIndexes(...args: any[]): any; //insert(...args: any[]): any; //mapReduce(...args: any[]): any; //save(...args: any[]): any; //update(...args: any[]): any; /** The collection name */ collectionName: string; /** The Connection instance */ conn: Connection; /** The collection name */ name: string; } } |