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 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648
|
// tslint:disable:jsdoc-format
// tslint:disable:max-line-length
// tslint:disable:no-irregular-whitespace
declare namespace JQuery {
type TypeOrArray<T> = T | T[];
type Node = Element | Text | Comment | Document | DocumentFragment;
/**
* A string is designated htmlString in jQuery documentation when it is used to represent one or more DOM elements, typically to be created and inserted in the document. When passed as an argument of the jQuery() function, the string is identified as HTML if it starts with <tag ... >) and is parsed as such until the final > character. Prior to jQuery 1.9, a string was considered to be HTML if it contained <tag ... > anywhere within the string.
*/
type htmlString = string;
/**
* A selector is used in jQuery to select DOM elements from a DOM document. That document is, in most cases, the DOM document present in all browsers, but can also be an XML document received via Ajax.
*/
type Selector = string;
/**
* The PlainObject type is a JavaScript object containing zero or more key-value pairs. The plain object is, in other words, an Object object. It is designated "plain" in jQuery documentation to distinguish it from other kinds of JavaScript objects: for example, null, user-defined arrays, and host objects such as document, all of which have a typeof value of "object."
*
* **Note**: The type declaration of PlainObject is imprecise. It includes host objects and user-defined arrays which do not match jQuery's definition.
*/
interface PlainObject<T = any> {
[key: string]: T;
}
interface Selectors extends Sizzle.Selectors {
/**
* @deprecated Deprecated since 3.0. Use \`{@link Selectors#pseudos }\`.
*
* **Cause**: The standard way to add new custom selectors through jQuery is `jQuery.expr.pseudos`. These two other aliases are deprecated, although they still work as of jQuery 3.0.
*
* **Solution**: Rename any of the older usage to `jQuery.expr.pseudos`. The functionality is identical.
*/
':': Sizzle.Selectors.PseudoFunctions;
/**
* @deprecated Deprecated since 3.0. Use \`{@link Selectors#pseudos }\`.
*
* **Cause**: The standard way to add new custom selectors through jQuery is `jQuery.expr.pseudos`. These two other aliases are deprecated, although they still work as of jQuery 3.0.
*
* **Solution**: Rename any of the older usage to `jQuery.expr.pseudos`. The functionality is identical.
*/
filter: Sizzle.Selectors.FilterFunctions;
}
// region Ajax
// #region Ajax
interface AjaxSettings<TContext = any> extends Ajax.AjaxSettingsBase<TContext> {
/**
* A string containing the URL to which the request is sent.
*/
url?: string;
}
interface UrlAjaxSettings<TContext = any> extends Ajax.AjaxSettingsBase<TContext> {
/**
* A string containing the URL to which the request is sent.
*/
url: string;
}
namespace Ajax {
type SuccessTextStatus = 'success' | 'notmodified' | 'nocontent';
type ErrorTextStatus = 'timeout' | 'error' | 'abort' | 'parsererror';
type TextStatus = SuccessTextStatus | ErrorTextStatus;
type SuccessCallback<TContext> = (this: TContext, data: any, textStatus: SuccessTextStatus, jqXHR: jqXHR) => void;
type ErrorCallback<TContext> = (this: TContext, jqXHR: jqXHR, textStatus: ErrorTextStatus, errorThrown: string) => void;
type CompleteCallback<TContext> = (this: TContext, jqXHR: jqXHR, textStatus: TextStatus) => void;
/**
* @see \`{@link https://api.jquery.com/jquery.ajax/#jQuery-ajax-settings }\`
*/
interface AjaxSettingsBase<TContext> {
/**
* A set of key/value pairs that map a given dataType to its MIME type, which gets sent in the Accept request header. This header tells the server what kind of response it will accept in return.
*/
accepts?: PlainObject<string>;
/**
* By default, all requests are sent asynchronously (i.e. this is set to true by default). If you need synchronous requests, set this option to false. Cross-domain requests and dataType: "jsonp" requests do not support synchronous operation. Note that synchronous requests may temporarily lock the browser, disabling any actions while the request is active. As of jQuery 1.8, the use of async: false with jqXHR ($.Deferred) is deprecated; you must use the success/error/complete callback options instead of the corresponding methods of the jqXHR object such as jqXHR.done().
*/
async?: boolean;
/**
* A pre-request callback function that can be used to modify the jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object before it is sent. Use this to set custom headers, etc. The jqXHR and settings objects are passed as arguments. This is an Ajax Event. Returning false in the beforeSend function will cancel the request. As of jQuery 1.5, the beforeSend option will be called regardless of the type of request.
*/
beforeSend?(this: TContext, jqXHR: jqXHR, settings: this): false | void;
/**
* If set to false, it will force requested pages not to be cached by the browser. Note: Setting cache to false will only work correctly with HEAD and GET requests. It works by appending "_={timestamp}" to the GET parameters. The parameter is not needed for other types of requests, except in IE8 when a POST is made to a URL that has already been requested by a GET.
*/
cache?: boolean;
/**
* A function to be called when the request finishes (after success and error callbacks are executed). The function gets passed two arguments: The jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object and a string categorizing the status of the request ("success", "notmodified", "nocontent", "error", "timeout", "abort", or "parsererror"). As of jQuery 1.5, the complete setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event.
*/
complete?: TypeOrArray<CompleteCallback<TContext>>;
/**
* An object of string/regular-expression pairs that determine how jQuery will parse the response, given its content type.
*/
contents?: PlainObject<RegExp>;
/**
* When sending data to the server, use this content type. Default is "application/x-www-form-urlencoded; charset=UTF-8", which is fine for most cases. If you explicitly pass in a content-type to $.ajax(), then it is always sent to the server (even if no data is sent). As of jQuery 1.6 you can pass false to tell jQuery to not set any content type header. Note: The W3C XMLHttpRequest specification dictates that the charset is always UTF-8; specifying another charset will not force the browser to change the encoding. Note: For cross-domain requests, setting the content type to anything other than application/x-www-form-urlencoded, multipart/form-data, or text/plain will trigger the browser to send a preflight OPTIONS request to the server.
*/
contentType?: string | false;
/**
* This object will be the context of all Ajax-related callbacks. By default, the context is an object that represents the Ajax settings used in the call ($.ajaxSettings merged with the settings passed to $.ajax).
*/
context?: TContext;
/**
* An object containing dataType-to-dataType converters. Each converter's value is a function that returns the transformed value of the response.
*/
converters?: PlainObject<((value: any) => any) | true>;
/**
* If you wish to force a crossDomain request (such as JSONP) on the same domain, set the value of crossDomain to true. This allows, for example, server-side redirection to another domain.
*/
crossDomain?: boolean;
/**
* Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests. See processData option to prevent this automatic processing. Object must be Key/Value pairs. If value is an Array, jQuery serializes multiple values with same key based on the value of the traditional setting (described below).
*/
data?: PlainObject | string;
/**
* A function to be used to handle the raw response data of XMLHttpRequest. This is a pre-filtering function to sanitize the response. You should return the sanitized data. The function accepts two arguments: The raw data returned from the server and the 'dataType' parameter.
*/
dataFilter?(data: string, type: string): any;
/**
* The type of data that you're expecting back from the server. If none is specified, jQuery will try to infer it based on the MIME type of the response (an XML MIME type will yield XML, in 1.4 JSON will yield a JavaScript object, in 1.4 script will execute the script, and anything else will be returned as a string). The available types (and the result passed as the first argument to your success callback) are:
*
* "xml": Returns a XML document that can be processed via jQuery.
*
* "html": Returns HTML as plain text; included script tags are evaluated when inserted in the DOM.
*
* "script": Evaluates the response as JavaScript and returns it as plain text. Disables caching by appending a query string parameter, _=[TIMESTAMP], to the URL unless the cache option is set to true. Note: This will turn POSTs into GETs for remote-domain requests.
*
* "json": Evaluates the response as JSON and returns a JavaScript object. Cross-domain "json" requests are converted to "jsonp" unless the request includes jsonp: false in its request options. The JSON data is parsed in a strict manner; any malformed JSON is rejected and a parse error is thrown. As of jQuery 1.9, an empty response is also rejected; the server should return a response of null or {} instead. (See json.org for more information on proper JSON formatting.)
*
* "jsonp": Loads in a JSON block using JSONP. Adds an extra "?callback=?" to the end of your URL to specify the callback. Disables caching by appending a query string parameter, "_=[TIMESTAMP]", to the URL unless the cache option is set to true.
*
* "text": A plain text string.
*
* multiple, space-separated values: As of jQuery 1.5, jQuery can convert a dataType from what it received in the Content-Type header to what you require. For example, if you want a text response to be treated as XML, use "text xml" for the dataType. You can also make a JSONP request, have it received as text, and interpreted by jQuery as XML: "jsonp text xml". Similarly, a shorthand string such as "jsonp xml" will first attempt to convert from jsonp to xml, and, failing that, convert from jsonp to text, and then from text to xml.
*/
dataType?: 'xml' | 'html' | 'script' | 'json' | 'jsonp' | 'text' | string;
/**
* The MIME type of content that is used to submit the form to the server. Possible values are:
*
* "application/x-www-form-urlencoded": The initial default type.
*
* "multipart/form-data": The type that allows file <input> element(s) to upload file data.
*
* "text/plain": A type introduced in HTML5.
*/
enctype?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain';
/**
* A function to be called if the request fails. The function receives three arguments: The jqXHR (in jQuery 1.4.x, XMLHttpRequest) object, a string describing the type of error that occurred and an optional exception object, if one occurred. Possible values for the second argument (besides null) are "timeout", "error", "abort", and "parsererror". When an HTTP error occurs, errorThrown receives the textual portion of the HTTP status, such as "Not Found" or "Internal Server Error." As of jQuery 1.5, the error setting can accept an array of functions. Each function will be called in turn. Note: This handler is not called for cross-domain script and cross-domain JSONP requests. This is an Ajax Event.
*/
error?: TypeOrArray<ErrorCallback<TContext>>;
/**
* Whether to trigger global Ajax event handlers for this request. The default is true. Set to false to prevent the global handlers like ajaxStart or ajaxStop from being triggered. This can be used to control various Ajax Events.
*/
global?: boolean;
/**
* An object of additional header key/value pairs to send along with requests using the XMLHttpRequest transport. The header X-Requested-With: XMLHttpRequest is always added, but its default XMLHttpRequest value can be changed here. Values in the headers setting can also be overwritten from within the beforeSend function.
*/
headers?: PlainObject<string | null | undefined>;
/**
* Allow the request to be successful only if the response has changed since the last request. This is done by checking the Last-Modified header. Default value is false, ignoring the header. In jQuery 1.4 this technique also checks the 'etag' specified by the server to catch unmodified data.
*/
ifModified?: boolean;
/**
* Allow the current environment to be recognized as "local," (e.g. the filesystem), even if jQuery does not recognize it as such by default. The following protocols are currently recognized as local: file, *-extension, and widget. If the isLocal setting needs modification, it is recommended to do so once in the $.ajaxSetup() method.
*/
isLocal?: boolean;
/**
* Override the callback function name in a JSONP request. This value will be used instead of 'callback' in the 'callback=?' part of the query string in the url. So {jsonp:'onJSONPLoad'} would result in 'onJSONPLoad=?' passed to the server. As of jQuery 1.5, setting the jsonp option to false prevents jQuery from adding the "?callback" string to the URL or attempting to use "=?" for transformation. In this case, you should also explicitly set the jsonpCallback setting. For example, { jsonp: false, jsonpCallback: "callbackName" }. If you don't trust the target of your Ajax requests, consider setting the jsonp property to false for security reasons.
*/
jsonp?: string | false;
/**
* Specify the callback function name for a JSONP request. This value will be used instead of the random name automatically generated by jQuery. It is preferable to let jQuery generate a unique name as it'll make it easier to manage the requests and provide callbacks and error handling. You may want to specify the callback when you want to enable better browser caching of GET requests. As of jQuery 1.5, you can also use a function for this setting, in which case the value of jsonpCallback is set to the return value of that function.
*/
jsonpCallback?: string | ((this: TContext) => string);
/**
* The HTTP method to use for the request (e.g. "POST", "GET", "PUT").
*/
method?: string;
/**
* A mime type to override the XHR mime type.
*/
mimeType?: string;
/**
* A password to be used with XMLHttpRequest in response to an HTTP access authentication request.
*/
password?: string;
/**
* By default, data passed in to the data option as an object (technically, anything other than a string) will be processed and transformed into a query string, fitting to the default content-type "application/x-www-form-urlencoded". If you want to send a DOMDocument, or other non-processed data, set this option to false.
*/
processData?: boolean;
/**
* Only applies when the "script" transport is used (e.g., cross-domain requests with "jsonp" or "script" dataType and "GET" type). Sets the charset attribute on the script tag used in the request. Used when the character set on the local page is not the same as the one on the remote script.
*/
scriptCharset?: string;
/**
* An object of numeric HTTP codes and functions to be called when the response has the corresponding code.
*
* If the request is successful, the status code functions take the same parameters as the success callback; if it results in an error (including 3xx redirect), they take the same parameters as the error callback.
*/
statusCode?: StatusCodeCallbacks<TContext>;
/**
* A function to be called if the request succeeds. The function gets passed three arguments: The data returned from the server, formatted according to the dataType parameter or the dataFilter callback function, if specified; a string describing the status; and the jqXHR (in jQuery 1.4.x, XMLHttpRequest) object. As of jQuery 1.5, the success setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event.
*/
success?: TypeOrArray<SuccessCallback<TContext>>;
/**
* Set a timeout (in milliseconds) for the request. A value of 0 means there will be no timeout. This will override any global timeout set with $.ajaxSetup(). The timeout period starts at the point the $.ajax call is made; if several other requests are in progress and the browser has no connections available, it is possible for a request to time out before it can be sent. In jQuery 1.4.x and below, the XMLHttpRequest object will be in an invalid state if the request times out; accessing any object members may throw an exception. In Firefox 3.0+ only, script and JSONP requests cannot be cancelled by a timeout; the script will run even if it arrives after the timeout period.
*/
timeout?: number;
/**
* Set this to true if you wish to use the traditional style of param serialization.
*/
traditional?: boolean;
/**
* An alias for method. You should use type if you're using versions of jQuery prior to 1.9.0.
*/
type?: string;
/**
* A username to be used with XMLHttpRequest in response to an HTTP access authentication request.
*/
username?: string;
// ActiveXObject requires "lib": ["scripthost"] which consumers would also require
/**
* Callback for creating the XMLHttpRequest object. Defaults to the ActiveXObject when available (IE), the XMLHttpRequest otherwise. Override to provide your own implementation for XMLHttpRequest or enhancements to the factory.
*/
xhr?(): XMLHttpRequest;
/**
* An object of fieldName-fieldValue pairs to set on the native XHR object.
*
* In jQuery 1.5, the withCredentials property was not propagated to the native XHR and thus CORS requests requiring it would ignore this flag. For this reason, we recommend using jQuery 1.5.1+ should you require the use of it.
*/
xhrFields?: XHRFields;
}
// region StatusCodeCallbacks
// #region StatusCodeCallbacks
type StatusCodeCallbacks<TContext> = {
// region Success Status Codes
// #region Success Status Codes
// jQuery treats 2xx and 304 status codes as a success
200?: SuccessCallback<TContext>;
201?: SuccessCallback<TContext>;
202?: SuccessCallback<TContext>;
203?: SuccessCallback<TContext>;
204?: SuccessCallback<TContext>;
205?: SuccessCallback<TContext>;
206?: SuccessCallback<TContext>;
207?: SuccessCallback<TContext>;
208?: SuccessCallback<TContext>;
209?: SuccessCallback<TContext>;
210?: SuccessCallback<TContext>;
211?: SuccessCallback<TContext>;
212?: SuccessCallback<TContext>;
213?: SuccessCallback<TContext>;
214?: SuccessCallback<TContext>;
215?: SuccessCallback<TContext>;
216?: SuccessCallback<TContext>;
217?: SuccessCallback<TContext>;
218?: SuccessCallback<TContext>;
219?: SuccessCallback<TContext>;
220?: SuccessCallback<TContext>;
221?: SuccessCallback<TContext>;
222?: SuccessCallback<TContext>;
223?: SuccessCallback<TContext>;
224?: SuccessCallback<TContext>;
225?: SuccessCallback<TContext>;
226?: SuccessCallback<TContext>;
227?: SuccessCallback<TContext>;
228?: SuccessCallback<TContext>;
229?: SuccessCallback<TContext>;
230?: SuccessCallback<TContext>;
231?: SuccessCallback<TContext>;
232?: SuccessCallback<TContext>;
233?: SuccessCallback<TContext>;
234?: SuccessCallback<TContext>;
235?: SuccessCallback<TContext>;
236?: SuccessCallback<TContext>;
237?: SuccessCallback<TContext>;
238?: SuccessCallback<TContext>;
239?: SuccessCallback<TContext>;
240?: SuccessCallback<TContext>;
241?: SuccessCallback<TContext>;
242?: SuccessCallback<TContext>;
243?: SuccessCallback<TContext>;
244?: SuccessCallback<TContext>;
245?: SuccessCallback<TContext>;
246?: SuccessCallback<TContext>;
247?: SuccessCallback<TContext>;
248?: SuccessCallback<TContext>;
249?: SuccessCallback<TContext>;
250?: SuccessCallback<TContext>;
251?: SuccessCallback<TContext>;
252?: SuccessCallback<TContext>;
253?: SuccessCallback<TContext>;
254?: SuccessCallback<TContext>;
255?: SuccessCallback<TContext>;
256?: SuccessCallback<TContext>;
257?: SuccessCallback<TContext>;
258?: SuccessCallback<TContext>;
259?: SuccessCallback<TContext>;
260?: SuccessCallback<TContext>;
261?: SuccessCallback<TContext>;
262?: SuccessCallback<TContext>;
263?: SuccessCallback<TContext>;
264?: SuccessCallback<TContext>;
265?: SuccessCallback<TContext>;
266?: SuccessCallback<TContext>;
267?: SuccessCallback<TContext>;
268?: SuccessCallback<TContext>;
269?: SuccessCallback<TContext>;
270?: SuccessCallback<TContext>;
271?: SuccessCallback<TContext>;
272?: SuccessCallback<TContext>;
273?: SuccessCallback<TContext>;
274?: SuccessCallback<TContext>;
275?: SuccessCallback<TContext>;
276?: SuccessCallback<TContext>;
277?: SuccessCallback<TContext>;
278?: SuccessCallback<TContext>;
279?: SuccessCallback<TContext>;
280?: SuccessCallback<TContext>;
281?: SuccessCallback<TContext>;
282?: SuccessCallback<TContext>;
283?: SuccessCallback<TContext>;
284?: SuccessCallback<TContext>;
285?: SuccessCallback<TContext>;
286?: SuccessCallback<TContext>;
287?: SuccessCallback<TContext>;
288?: SuccessCallback<TContext>;
289?: SuccessCallback<TContext>;
290?: SuccessCallback<TContext>;
291?: SuccessCallback<TContext>;
292?: SuccessCallback<TContext>;
293?: SuccessCallback<TContext>;
294?: SuccessCallback<TContext>;
295?: SuccessCallback<TContext>;
296?: SuccessCallback<TContext>;
297?: SuccessCallback<TContext>;
298?: SuccessCallback<TContext>;
299?: SuccessCallback<TContext>;
304?: SuccessCallback<TContext>;
// #endregion
// region Error Status Codes
// #region Error Status Codes
300?: ErrorCallback<TContext>;
301?: ErrorCallback<TContext>;
302?: ErrorCallback<TContext>;
303?: ErrorCallback<TContext>;
305?: ErrorCallback<TContext>;
306?: ErrorCallback<TContext>;
307?: ErrorCallback<TContext>;
308?: ErrorCallback<TContext>;
309?: ErrorCallback<TContext>;
310?: ErrorCallback<TContext>;
311?: ErrorCallback<TContext>;
312?: ErrorCallback<TContext>;
313?: ErrorCallback<TContext>;
314?: ErrorCallback<TContext>;
315?: ErrorCallback<TContext>;
316?: ErrorCallback<TContext>;
317?: ErrorCallback<TContext>;
318?: ErrorCallback<TContext>;
319?: ErrorCallback<TContext>;
320?: ErrorCallback<TContext>;
321?: ErrorCallback<TContext>;
322?: ErrorCallback<TContext>;
323?: ErrorCallback<TContext>;
324?: ErrorCallback<TContext>;
325?: ErrorCallback<TContext>;
326?: ErrorCallback<TContext>;
327?: ErrorCallback<TContext>;
328?: ErrorCallback<TContext>;
329?: ErrorCallback<TContext>;
330?: ErrorCallback<TContext>;
331?: ErrorCallback<TContext>;
332?: ErrorCallback<TContext>;
333?: ErrorCallback<TContext>;
334?: ErrorCallback<TContext>;
335?: ErrorCallback<TContext>;
336?: ErrorCallback<TContext>;
337?: ErrorCallback<TContext>;
338?: ErrorCallback<TContext>;
339?: ErrorCallback<TContext>;
340?: ErrorCallback<TContext>;
341?: ErrorCallback<TContext>;
342?: ErrorCallback<TContext>;
343?: ErrorCallback<TContext>;
344?: ErrorCallback<TContext>;
345?: ErrorCallback<TContext>;
346?: ErrorCallback<TContext>;
347?: ErrorCallback<TContext>;
348?: ErrorCallback<TContext>;
349?: ErrorCallback<TContext>;
350?: ErrorCallback<TContext>;
351?: ErrorCallback<TContext>;
352?: ErrorCallback<TContext>;
353?: ErrorCallback<TContext>;
354?: ErrorCallback<TContext>;
355?: ErrorCallback<TContext>;
356?: ErrorCallback<TContext>;
357?: ErrorCallback<TContext>;
358?: ErrorCallback<TContext>;
359?: ErrorCallback<TContext>;
360?: ErrorCallback<TContext>;
361?: ErrorCallback<TContext>;
362?: ErrorCallback<TContext>;
363?: ErrorCallback<TContext>;
364?: ErrorCallback<TContext>;
365?: ErrorCallback<TContext>;
366?: ErrorCallback<TContext>;
367?: ErrorCallback<TContext>;
368?: ErrorCallback<TContext>;
369?: ErrorCallback<TContext>;
370?: ErrorCallback<TContext>;
371?: ErrorCallback<TContext>;
372?: ErrorCallback<TContext>;
373?: ErrorCallback<TContext>;
374?: ErrorCallback<TContext>;
375?: ErrorCallback<TContext>;
376?: ErrorCallback<TContext>;
377?: ErrorCallback<TContext>;
378?: ErrorCallback<TContext>;
379?: ErrorCallback<TContext>;
380?: ErrorCallback<TContext>;
381?: ErrorCallback<TContext>;
382?: ErrorCallback<TContext>;
383?: ErrorCallback<TContext>;
384?: ErrorCallback<TContext>;
385?: ErrorCallback<TContext>;
386?: ErrorCallback<TContext>;
387?: ErrorCallback<TContext>;
388?: ErrorCallback<TContext>;
389?: ErrorCallback<TContext>;
390?: ErrorCallback<TContext>;
391?: ErrorCallback<TContext>;
392?: ErrorCallback<TContext>;
393?: ErrorCallback<TContext>;
394?: ErrorCallback<TContext>;
395?: ErrorCallback<TContext>;
396?: ErrorCallback<TContext>;
397?: ErrorCallback<TContext>;
398?: ErrorCallback<TContext>;
399?: ErrorCallback<TContext>;
400?: ErrorCallback<TContext>;
401?: ErrorCallback<TContext>;
402?: ErrorCallback<TContext>;
403?: ErrorCallback<TContext>;
404?: ErrorCallback<TContext>;
405?: ErrorCallback<TContext>;
406?: ErrorCallback<TContext>;
407?: ErrorCallback<TContext>;
408?: ErrorCallback<TContext>;
409?: ErrorCallback<TContext>;
410?: ErrorCallback<TContext>;
411?: ErrorCallback<TContext>;
412?: ErrorCallback<TContext>;
413?: ErrorCallback<TContext>;
414?: ErrorCallback<TContext>;
415?: ErrorCallback<TContext>;
416?: ErrorCallback<TContext>;
417?: ErrorCallback<TContext>;
418?: ErrorCallback<TContext>;
419?: ErrorCallback<TContext>;
420?: ErrorCallback<TContext>;
421?: ErrorCallback<TContext>;
422?: ErrorCallback<TContext>;
423?: ErrorCallback<TContext>;
424?: ErrorCallback<TContext>;
425?: ErrorCallback<TContext>;
426?: ErrorCallback<TContext>;
427?: ErrorCallback<TContext>;
428?: ErrorCallback<TContext>;
429?: ErrorCallback<TContext>;
430?: ErrorCallback<TContext>;
431?: ErrorCallback<TContext>;
432?: ErrorCallback<TContext>;
433?: ErrorCallback<TContext>;
434?: ErrorCallback<TContext>;
435?: ErrorCallback<TContext>;
436?: ErrorCallback<TContext>;
437?: ErrorCallback<TContext>;
438?: ErrorCallback<TContext>;
439?: ErrorCallback<TContext>;
440?: ErrorCallback<TContext>;
441?: ErrorCallback<TContext>;
442?: ErrorCallback<TContext>;
443?: ErrorCallback<TContext>;
444?: ErrorCallback<TContext>;
445?: ErrorCallback<TContext>;
446?: ErrorCallback<TContext>;
447?: ErrorCallback<TContext>;
448?: ErrorCallback<TContext>;
449?: ErrorCallback<TContext>;
450?: ErrorCallback<TContext>;
451?: ErrorCallback<TContext>;
452?: ErrorCallback<TContext>;
453?: ErrorCallback<TContext>;
454?: ErrorCallback<TContext>;
455?: ErrorCallback<TContext>;
456?: ErrorCallback<TContext>;
457?: ErrorCallback<TContext>;
458?: ErrorCallback<TContext>;
459?: ErrorCallback<TContext>;
460?: ErrorCallback<TContext>;
461?: ErrorCallback<TContext>;
462?: ErrorCallback<TContext>;
463?: ErrorCallback<TContext>;
464?: ErrorCallback<TContext>;
465?: ErrorCallback<TContext>;
466?: ErrorCallback<TContext>;
467?: ErrorCallback<TContext>;
468?: ErrorCallback<TContext>;
469?: ErrorCallback<TContext>;
470?: ErrorCallback<TContext>;
471?: ErrorCallback<TContext>;
472?: ErrorCallback<TContext>;
473?: ErrorCallback<TContext>;
474?: ErrorCallback<TContext>;
475?: ErrorCallback<TContext>;
476?: ErrorCallback<TContext>;
477?: ErrorCallback<TContext>;
478?: ErrorCallback<TContext>;
479?: ErrorCallback<TContext>;
480?: ErrorCallback<TContext>;
481?: ErrorCallback<TContext>;
482?: ErrorCallback<TContext>;
483?: ErrorCallback<TContext>;
484?: ErrorCallback<TContext>;
485?: ErrorCallback<TContext>;
486?: ErrorCallback<TContext>;
487?: ErrorCallback<TContext>;
488?: ErrorCallback<TContext>;
489?: ErrorCallback<TContext>;
490?: ErrorCallback<TContext>;
491?: ErrorCallback<TContext>;
492?: ErrorCallback<TContext>;
493?: ErrorCallback<TContext>;
494?: ErrorCallback<TContext>;
495?: ErrorCallback<TContext>;
496?: ErrorCallback<TContext>;
497?: ErrorCallback<TContext>;
498?: ErrorCallback<TContext>;
499?: ErrorCallback<TContext>;
500?: ErrorCallback<TContext>;
501?: ErrorCallback<TContext>;
502?: ErrorCallback<TContext>;
503?: ErrorCallback<TContext>;
504?: ErrorCallback<TContext>;
505?: ErrorCallback<TContext>;
506?: ErrorCallback<TContext>;
507?: ErrorCallback<TContext>;
508?: ErrorCallback<TContext>;
509?: ErrorCallback<TContext>;
510?: ErrorCallback<TContext>;
511?: ErrorCallback<TContext>;
512?: ErrorCallback<TContext>;
513?: ErrorCallback<TContext>;
514?: ErrorCallback<TContext>;
515?: ErrorCallback<TContext>;
516?: ErrorCallback<TContext>;
517?: ErrorCallback<TContext>;
518?: ErrorCallback<TContext>;
519?: ErrorCallback<TContext>;
520?: ErrorCallback<TContext>;
521?: ErrorCallback<TContext>;
522?: ErrorCallback<TContext>;
523?: ErrorCallback<TContext>;
524?: ErrorCallback<TContext>;
525?: ErrorCallback<TContext>;
526?: ErrorCallback<TContext>;
527?: ErrorCallback<TContext>;
528?: ErrorCallback<TContext>;
529?: ErrorCallback<TContext>;
530?: ErrorCallback<TContext>;
531?: ErrorCallback<TContext>;
532?: ErrorCallback<TContext>;
533?: ErrorCallback<TContext>;
534?: ErrorCallback<TContext>;
535?: ErrorCallback<TContext>;
536?: ErrorCallback<TContext>;
537?: ErrorCallback<TContext>;
538?: ErrorCallback<TContext>;
539?: ErrorCallback<TContext>;
540?: ErrorCallback<TContext>;
541?: ErrorCallback<TContext>;
542?: ErrorCallback<TContext>;
543?: ErrorCallback<TContext>;
544?: ErrorCallback<TContext>;
545?: ErrorCallback<TContext>;
546?: ErrorCallback<TContext>;
547?: ErrorCallback<TContext>;
548?: ErrorCallback<TContext>;
549?: ErrorCallback<TContext>;
550?: ErrorCallback<TContext>;
551?: ErrorCallback<TContext>;
552?: ErrorCallback<TContext>;
553?: ErrorCallback<TContext>;
554?: ErrorCallback<TContext>;
555?: ErrorCallback<TContext>;
556?: ErrorCallback<TContext>;
557?: ErrorCallback<TContext>;
558?: ErrorCallback<TContext>;
559?: ErrorCallback<TContext>;
560?: ErrorCallback<TContext>;
561?: ErrorCallback<TContext>;
562?: ErrorCallback<TContext>;
563?: ErrorCallback<TContext>;
564?: ErrorCallback<TContext>;
565?: ErrorCallback<TContext>;
566?: ErrorCallback<TContext>;
567?: ErrorCallback<TContext>;
568?: ErrorCallback<TContext>;
569?: ErrorCallback<TContext>;
570?: ErrorCallback<TContext>;
571?: ErrorCallback<TContext>;
572?: ErrorCallback<TContext>;
573?: ErrorCallback<TContext>;
574?: ErrorCallback<TContext>;
575?: ErrorCallback<TContext>;
576?: ErrorCallback<TContext>;
577?: ErrorCallback<TContext>;
578?: ErrorCallback<TContext>;
579?: ErrorCallback<TContext>;
580?: ErrorCallback<TContext>;
581?: ErrorCallback<TContext>;
582?: ErrorCallback<TContext>;
583?: ErrorCallback<TContext>;
584?: ErrorCallback<TContext>;
585?: ErrorCallback<TContext>;
586?: ErrorCallback<TContext>;
587?: ErrorCallback<TContext>;
588?: ErrorCallback<TContext>;
589?: ErrorCallback<TContext>;
590?: ErrorCallback<TContext>;
591?: ErrorCallback<TContext>;
592?: ErrorCallback<TContext>;
593?: ErrorCallback<TContext>;
594?: ErrorCallback<TContext>;
595?: ErrorCallback<TContext>;
596?: ErrorCallback<TContext>;
597?: ErrorCallback<TContext>;
598?: ErrorCallback<TContext>;
599?: ErrorCallback<TContext>;
// #endregion
} & {
// Status codes not listed require type annotations when defining the callback
[index: number]: SuccessCallback<TContext> | ErrorCallback<TContext>;
};
// #endregion
// Writable properties on XMLHttpRequest
interface XHRFields extends Partial<Pick<XMLHttpRequest, 'onreadystatechange' | 'responseType' | 'timeout' | 'withCredentials'>> {
msCaching?: string;
}
}
interface Transport {
send(headers: PlainObject, completeCallback: Transport.SuccessCallback): void;
abort(): void;
}
namespace Transport {
type SuccessCallback = (status: number, statusText: Ajax.TextStatus, responses?: PlainObject, headers?: string) => void;
}
/**
* @see \`{@link https://api.jquery.com/jquery.ajax/#jqXHR }\`
*/
interface jqXHR<TResolve = any> extends Promise3<TResolve, jqXHR<TResolve>, never,
Ajax.SuccessTextStatus, Ajax.ErrorTextStatus, never,
jqXHR<TResolve>, string, never>,
Pick<XMLHttpRequest, 'abort' | 'getAllResponseHeaders' | 'getResponseHeader' | 'overrideMimeType' | 'readyState' | 'responseText' |
'setRequestHeader' | 'status' | 'statusText'>,
Partial<Pick<XMLHttpRequest, 'responseXML'>> {
responseJSON?: any;
abort(statusText?: string): void;
/**
* Determine the current state of a Deferred object.
* @see \`{@link https://api.jquery.com/deferred.state/ }\`
* @since 1.7
*/
state(): 'pending' | 'resolved' | 'rejected';
statusCode(map: Ajax.StatusCodeCallbacks<any>): void;
}
namespace jqXHR {
interface DoneCallback<TResolve = any, TjqXHR = jqXHR<TResolve>> extends Deferred.Callback3<TResolve, Ajax.SuccessTextStatus, TjqXHR> { }
interface FailCallback<TjqXHR> extends Deferred.Callback3<TjqXHR, Ajax.ErrorTextStatus, string> { }
interface AlwaysCallback<TResolve = any, TjqXHR = jqXHR<TResolve>> extends Deferred.Callback3<TResolve | TjqXHR, Ajax.TextStatus, TjqXHR | string> { }
}
// #endregion
// region Callbacks
// #region Callbacks
interface CallbacksStatic {
/**
* A multi-purpose callbacks list object that provides a powerful way to manage callback lists.
* @param flags An optional list of space-separated flags that change how the callback list behaves.
* @see \`{@link https://api.jquery.com/jQuery.Callbacks/ }\`
* @since 1.7
*/
// tslint:disable-next-line:ban-types no-unnecessary-generics
<T extends Function>(flags?: string): Callbacks<T>;
}
// tslint:disable-next-line:ban-types
interface Callbacks<T extends Function = Function> {
/**
* Add a callback or a collection of callbacks to a callback list.
* @param callback A function, or array of functions, that are to be added to the callback list.
* @param callbacks A function, or array of functions, that are to be added to the callback list.
* @see \`{@link https://api.jquery.com/callbacks.add/ }\`
* @since 1.7
* @example ````Use callbacks.add() to add new callbacks to a callback list:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value ) {
console.log( "foo: " + value );
};
// Another function to also be added to the list
var bar = function( value ) {
console.log( "bar: " + value );
};
var callbacks = $.Callbacks();
// Add the function "foo" to the list
callbacks.add( foo );
// Fire the items on the list
callbacks.fire( "hello" );
// Outputs: "foo: hello"
// Add the function "bar" to the list
callbacks.add( bar );
// Fire the items on the list again
callbacks.fire( "world" );
// Outputs:
// "foo: world"
// "bar: world"
```
*/
add(callback: TypeOrArray<T>, ...callbacks: Array<TypeOrArray<T>>): this;
/**
* Disable a callback list from doing anything more.
* @see \`{@link https://api.jquery.com/callbacks.disable/ }\`
* @since 1.7
* @example ````Use callbacks.disable() to disable further calls to a callback list:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value ) {
console.log( value );
};
var callbacks = $.Callbacks();
// Add the above function to the list
callbacks.add( foo );
// Fire the items on the list
callbacks.fire( "foo" );
// Outputs: foo
// Disable further calls being possible
callbacks.disable();
// Attempt to fire with "foobar" as an argument
callbacks.fire( "foobar" );
// foobar isn't output
```
*/
disable(): this;
/**
* Determine if the callbacks list has been disabled.
* @see \`{@link https://api.jquery.com/callbacks.disabled/ }\`
* @since 1.7
* @example ````Use callbacks.disabled() to determine if the callbacks list has been disabled:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value ) {
console.log( "foo:" + value );
};
var callbacks = $.Callbacks();
// Add the logging function to the callback list
callbacks.add( foo );
// Fire the items on the list, passing an argument
callbacks.fire( "hello" );
// Outputs "foo: hello"
// Disable the callbacks list
callbacks.disable();
// Test the disabled state of the list
console.log ( callbacks.disabled() );
// Outputs: true
```
*/
disabled(): boolean;
/**
* Remove all of the callbacks from a list.
* @see \`{@link https://api.jquery.com/callbacks.empty/ }\`
* @since 1.7
* @example ````Use callbacks.empty() to empty a list of callbacks:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value1, value2 ) {
console.log( "foo: " + value1 + "," + value2 );
};
// Another function to also be added to the list
var bar = function( value1, value2 ) {
console.log( "bar: " + value1 + "," + value2 );
};
var callbacks = $.Callbacks();
// Add the two functions
callbacks.add( foo );
callbacks.add( bar );
// Empty the callbacks list
callbacks.empty();
// Check to ensure all callbacks have been removed
console.log( callbacks.has( foo ) );
// false
console.log( callbacks.has( bar ) );
// false
```
*/
empty(): this;
/**
* Call all of the callbacks with the given arguments.
* @param args The argument or list of arguments to pass back to the callback list.
* @see \`{@link https://api.jquery.com/callbacks.fire/ }\`
* @since 1.7
* @example ````Use callbacks.fire() to invoke the callbacks in a list with any arguments that have been passed:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value ) {
console.log( "foo:" + value );
};
var callbacks = $.Callbacks();
// Add the function "foo" to the list
callbacks.add( foo );
// Fire the items on the list
callbacks.fire( "hello" ); // Outputs: "foo: hello"
callbacks.fire( "world" ); // Outputs: "foo: world"
// Add another function to the list
var bar = function( value ){
console.log( "bar:" + value );
};
// Add this function to the list
callbacks.add( bar );
// Fire the items on the list again
callbacks.fire( "hello again" );
// Outputs:
// "foo: hello again"
// "bar: hello again"
```
*/
fire(...args: any[]): this;
/**
* Determine if the callbacks have already been called at least once.
* @see \`{@link https://api.jquery.com/callbacks.fired/ }\`
* @since 1.7
* @example ````Use callbacks.fired() to determine if the callbacks in a list have been called at least once:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value ) {
console.log( "foo:" + value );
};
var callbacks = $.Callbacks();
// Add the function "foo" to the list
callbacks.add( foo );
// Fire the items on the list
callbacks.fire( "hello" ); // Outputs: "foo: hello"
callbacks.fire( "world" ); // Outputs: "foo: world"
// Test to establish if the callbacks have been called
console.log( callbacks.fired() );
```
*/
fired(): boolean;
/**
* Call all callbacks in a list with the given context and arguments.
* @param context A reference to the context in which the callbacks in the list should be fired.
* @param args An argument, or array of arguments, to pass to the callbacks in the list.
* @see \`{@link https://api.jquery.com/callbacks.fireWith/ }\`
* @since 1.7
* @example ````Use callbacks.fireWith() to fire a list of callbacks with a specific context and an array of arguments:
```javascript
// A sample logging function to be added to a callbacks list
var log = function( value1, value2 ) {
console.log( "Received: " + value1 + "," + value2 );
};
var callbacks = $.Callbacks();
// Add the log method to the callbacks list
callbacks.add( log );
// Fire the callbacks on the list using the context "window"
// and an arguments array
callbacks.fireWith( window, [ "foo","bar" ] );
// Outputs: "Received: foo, bar"
```
*/
fireWith(context: object, args?: ArrayLike<any>): this;
/**
* Determine whether or not the list has any callbacks attached. If a callback is provided as an argument, determine whether it is in a list.
* @param callback The callback to search for.
* @see \`{@link https://api.jquery.com/callbacks.has/ }\`
* @since 1.7
* @example ````Use callbacks.has() to check if a callback list contains a specific callback:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value1, value2 ) {
console.log( "Received: " + value1 + "," + value2 );
};
// A second function which will not be added to the list
var bar = function( value1, value2 ) {
console.log( "foobar" );
};
var callbacks = $.Callbacks();
// Add the log method to the callbacks list
callbacks.add( foo );
// Determine which callbacks are in the list
console.log( callbacks.has( foo ) );
// true
console.log( callbacks.has( bar ) );
// false
```
*/
has(callback?: T): boolean;
/**
* Lock a callback list in its current state.
* @see \`{@link https://api.jquery.com/callbacks.lock/ }\`
* @since 1.7
* @example ````Use callbacks.lock() to lock a callback list to avoid further changes being made to the list state:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value ) {
console.log( "foo:" + value );
};
var callbacks = $.Callbacks();
// Add the logging function to the callback list
callbacks.add( foo );
// Fire the items on the list, passing an argument
callbacks.fire( "hello" );
// Outputs "foo: hello"
// Lock the callbacks list
callbacks.lock();
// Try firing the items again
callbacks.fire( "world" );
// As the list was locked, no items were called,
// so "world" isn't logged
```
* @example ````Use callbacks.lock() to lock a callback list with "memory," and then resume using the list:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>callbacks.lock demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
// Simple function for logging results
var log = function( value ) {
$( "#log" ).append( "<p>" + value + "</p>" );
};
// Two sample functions to be added to a callbacks list
var foo = function( value ) {
log( "foo: " + value );
};
var bar = function( value ) {
log( "bar: " + value );
};
// Create the callbacks object with the "memory" flag
var callbacks = $.Callbacks( "memory" );
// Add the foo logging function to the callback list
callbacks.add( foo );
// Fire the items on the list, passing an argument
callbacks.fire( "hello" );
// Outputs "foo: hello"
// Lock the callbacks list
callbacks.lock();
// Try firing the items again
callbacks.fire( "world" );
// As the list was locked, no items were called,
// so "foo: world" isn't logged
// Add the foo function to the callback list again
callbacks.add( foo );
// Try firing the items again
callbacks.fire( "silentArgument" );
// Outputs "foo: hello" because the argument value was stored in memory
// Add the bar function to the callback list
callbacks.add( bar );
callbacks.fire( "youHadMeAtHello" );
// Outputs "bar: hello" because the list is still locked,
// and the argument value is still stored in memory
</script>
</body>
</html>
```
*/
lock(): this;
/**
* Determine if the callbacks list has been locked.
* @see \`{@link https://api.jquery.com/callbacks.locked/ }\`
* @since 1.7
* @example ````Use callbacks.locked() to determine the lock-state of a callback list:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value ) {
console.log( "foo: " + value );
};
var callbacks = $.Callbacks();
// Add the logging function to the callback list
callbacks.add( foo );
// Fire the items on the list, passing an argument
callbacks.fire( "hello" );
// Outputs "foo: hello"
// Lock the callbacks list
callbacks.lock();
// Test the lock-state of the list
console.log ( callbacks.locked() );
// true
```
*/
locked(): boolean;
/**
* Remove a callback or a collection of callbacks from a callback list.
* @param callbacks A function, or array of functions, that are to be removed from the callback list.
* @see \`{@link https://api.jquery.com/callbacks.remove/ }\`
* @since 1.7
* @example ````Use callbacks.remove() to remove callbacks from a callback list:
```javascript
// A sample logging function to be added to a callbacks list
var foo = function( value ) {
console.log( "foo: " + value );
};
var callbacks = $.Callbacks();
// Add the function "foo" to the list
callbacks.add( foo );
// Fire the items on the list
callbacks.fire( "hello" );
// Outputs: "foo: hello"
// Remove "foo" from the callback list
callbacks.remove( foo );
// Fire the items on the list again
callbacks.fire( "world" );
// Nothing output as "foo" is no longer in the list
```
*/
remove(...callbacks: T[]): this;
}
// #endregion
// region CSS hooks
// #region CSS hooks
// Workaround for TypeScript 2.3 which does not have support for weak types handling.
type CSSHook<TElement> =
Partial<_CSSHook<TElement>> & (
Pick<_CSSHook<TElement>, 'get'> |
Pick<_CSSHook<TElement>, 'set'>
);
interface _CSSHook<TElement> {
get(elem: TElement, computed: any, extra: any): any;
set(elem: TElement, value: any): void;
}
interface CSSHooks {
// Set to HTMLElement to minimize breaks but should probably be Element.
[propertyName: string]: CSSHook<HTMLElement>;
}
// #endregion
// region Deferred
// #region Deferred
/**
* Any object that has a then method.
*/
interface Thenable<T> extends PromiseLike<T> { }
// Type parameter guide
// --------------------
// Each type parameter represents a parameter in one of the three possible callbacks.
//
// The first letter indicates which position the parameter is in.
//
// T = A = 1st position
// U = B = 2nd position
// V = C = 3rd position
// S = R = rest position
//
// The second letter indicates which whether it is a [R]esolve, Re[J]ect, or [N]otify value.
//
// The third letter indicates whether the value is returned in the [D]one filter, [F]ail filter, or [P]rogress filter.
/**
* This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred.
* @see \`{@link https://api.jquery.com/Types/#Promise }\`
*/
interface PromiseBase<TR, TJ, TN,
UR, UJ, UN,
VR, VJ, VN,
SR, SJ, SN> {
/**
* Add handlers to be called when the Deferred object is either resolved or rejected.
* @param alwaysCallback A function, or array of functions, that is called when the Deferred is resolved or rejected.
* @param alwaysCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected.
* @see \`{@link https://api.jquery.com/deferred.always/ }\`
* @since 1.6
* @example ````Since the jQuery.get() method returns a jqXHR object, which is derived from a Deferred object, we can attach a callback for both success and error using the deferred.always() method.
```javascript
$.get( "test.php" ).always(function() {
alert( "$.get completed with success or error callback arguments" );
});
```
*/
always(alwaysCallback: TypeOrArray<Deferred.CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>>,
...alwaysCallbacks: Array<TypeOrArray<Deferred.CallbackBase<TR | TJ, UR | UJ, VR | VJ, SR | SJ>>>): this;
/**
* Add handlers to be called when the Deferred object is resolved.
* @param doneCallback A function, or array of functions, that are called when the Deferred is resolved.
* @param doneCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved.
* @see \`{@link https://api.jquery.com/deferred.done/ }\`
* @since 1.5
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach a success callback using the .done() method.
```javascript
$.get( "test.php" ).done(function() {
alert( "$.get succeeded" );
});
```
* @example ````Resolve a Deferred object when the user clicks a button, triggering a number of callback functions:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.done demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Go</button>
<p>Ready...</p>
<script>
// 3 functions to call when the Deferred object is resolved
function fn1() {
$( "p" ).append( " 1 " );
}
function fn2() {
$( "p" ).append( " 2 " );
}
function fn3( n ) {
$( "p" ).append( n + " 3 " + n );
}
// Create a deferred object
var dfd = $.Deferred();
// Add handlers to be called when dfd is resolved
dfd
// .done() can take any number of functions or arrays of functions
.done( [ fn1, fn2 ], fn3, [ fn2, fn1 ] )
// We can chain done methods, too
.done(function( n ) {
$( "p" ).append( n + " we're done." );
});
// Resolve the Deferred object when the button is clicked
$( "button" ).on( "click", function() {
dfd.resolve( "and" );
});
</script>
</body>
</html>
```
*/
done(doneCallback: TypeOrArray<Deferred.CallbackBase<TR, UR, VR, SR>>,
...doneCallbacks: Array<TypeOrArray<Deferred.CallbackBase<TR, UR, VR, SR>>>): this;
/**
* Add handlers to be called when the Deferred object is rejected.
* @param failCallback A function, or array of functions, that are called when the Deferred is rejected.
* @param failCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is rejected.
* @see \`{@link https://api.jquery.com/deferred.fail/ }\`
* @since 1.5
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred, you can attach a success and failure callback using the deferred.done() and deferred.fail() methods.
```javascript
$.get( "test.php" )
.done(function() {
alert( "$.get succeeded" );
})
.fail(function() {
alert( "$.get failed!" );
});
```
*/
fail(failCallback: TypeOrArray<Deferred.CallbackBase<TJ, UJ, VJ, SJ>>,
...failCallbacks: Array<TypeOrArray<Deferred.CallbackBase<TJ, UJ, VJ, SJ>>>): this;
/**
* Add handlers to be called when the Deferred object generates progress notifications.
* @param progressCallback A function, or array of functions, to be called when the Deferred generates progress notifications.
* @param progressCallbacks Optional additional functions, or arrays of functions, to be called when the Deferred generates
* progress notifications.
* @see \`{@link https://api.jquery.com/deferred.progress/ }\`
* @since 1.7
*/
progress(progressCallback: TypeOrArray<Deferred.CallbackBase<TN, UN, VN, SN>>,
...progressCallbacks: Array<TypeOrArray<Deferred.CallbackBase<TN, UN, VN, SN>>>): this;
/**
* Return a Deferred's Promise object.
* @param target Object onto which the promise methods have to be attached
* @see \`{@link https://api.jquery.com/deferred.promise/ }\`
* @since 1.5
* @example ````Create a Deferred and set two timer-based functions to either resolve or reject the Deferred after a random interval. Whichever one fires first "wins" and will call one of the callbacks. The second timeout has no effect since the Deferred is already complete (in a resolved or rejected state) from the first timeout action. Also set a timer-based progress notification function, and call a progress handler that adds "working..." to the document body.
```javascript
function asyncEvent() {
var dfd = jQuery.Deferred();
// Resolve after a random interval
setTimeout(function() {
dfd.resolve( "hurray" );
}, Math.floor( 400 + Math.random() * 2000 ) );
// Reject after a random interval
setTimeout(function() {
dfd.reject( "sorry" );
}, Math.floor( 400 + Math.random() * 2000 ) );
// Show a "working..." message every half-second
setTimeout(function working() {
if ( dfd.state() === "pending" ) {
dfd.notify( "working... " );
setTimeout( working, 500 );
}
}, 1 );
// Return the Promise so caller can't change the Deferred
return dfd.promise();
}
// Attach a done, fail, and progress handler for the asyncEvent
$.when( asyncEvent() ).then(
function( status ) {
alert( status + ", things are going well" );
},
function( status ) {
alert( status + ", you fail this time" );
},
function( status ) {
$( "body" ).append( status );
}
);
```
*/
promise<TTarget extends object>(target: TTarget): this & TTarget;
/**
* Return a Deferred's Promise object.
* @see \`{@link https://api.jquery.com/deferred.promise/ }\`
* @since 1.5
* @example ````Use the target argument to promote an existing object to a Promise:
```javascript
// Existing object
var obj = {
hello: function( name ) {
alert( "Hello " + name );
}
},
// Create a Deferred
defer = $.Deferred();
// Set object as a promise
defer.promise( obj );
// Resolve the deferred
defer.resolve( "John" );
// Use the object as a Promise
obj.done(function( name ) {
obj.hello( name ); // Will alert "Hello John"
}).hello( "Karl" ); // Will alert "Hello Karl"
```
*/
promise(): this;
/**
* Determine the current state of a Deferred object.
* @see \`{@link https://api.jquery.com/deferred.state/ }\`
* @since 1.7
*/
state(): 'pending' | 'resolved' | 'rejected';
// region pipe
// #region pipe
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter resolve value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<AJF> | AJF,
progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARD | ARF | ARP, AJD | AJF | AJP, AND | ANF | ANP,
BRD | BRF | BRP, BJD | BJF | BJP, BND | BNF | BNP,
CRD | CRF | CRP, CJD | CJF | CJP, CND | CNF | CNP,
RRD | RRF | RRP, RJD | RJF | RJP, RND | RNF | RNP>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: null,
failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<AJF> | AJF,
progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARF | ARP, AJF | AJP, ANF | ANP,
BRF | BRP, BJF | BJP, BNF | BNP,
CRF | CRP, CJF | CJP, CNF | CNP,
RRF | RRP, RJF | RJP, RNF | RNP>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter resolve value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: null,
progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARD | ARP, AJD | AJP, AND | ANP,
BRD | BRP, BJD | BJP, BND | BNP,
CRD | CRP, CJD | CJP, CND | CNP,
RRD | RRP, RJD | RJP, RND | RNP>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: null,
failFilter: null,
progressFilter?: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter resolve value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<AJF> | AJF,
progressFilter?: null): PromiseBase<ARD | ARF, AJD | AJF, AND | ANF,
BRD | BRF, BJD | BJF, BND | BNF,
CRD | CRF, CJD | CJF, CND | CNF,
RRD | RRF, RJD | RJF, RND | RNF>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
doneFilter: null,
failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<AJF> | AJF,
progressFilter?: null): PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter resolve value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never>(
doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter?: null,
progressFilter?: null): PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND>;
// #endregion
// region then
// #region then
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method.
```javascript
$.get( "test.php" ).then(
function() {
alert( "$.get succeeded" );
}, function() {
alert( "$.get failed!" );
}
);
```
* @example ````Filter the resolve value:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Filter Resolve</button>
<p></p>
<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};
$( "button" ).on( "click", filterResolve );
</script>
</body>
</html>
```
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF,
progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARD | ARF | ARP, AJD | AJF | AJP, AND | ANF | ANP,
BRD | BRF | BRP, BJD | BJF | BJP, BND | BNF | BNP,
CRD | CRF | CRP, CJD | CJF | CJP, CND | CNF | CNP,
RRD | RRF | RRP, RJD | RJF | RJP, RND | RNF | RNP>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: null,
failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF,
progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARF | ARP, AJF | AJP, ANF | ANP,
BRF | BRP, BJF | BJP, BNF | BNP,
CRF | CRP, CJF | CJP, CNF | CNP,
RRF | RRP, RJF | RJP, RNF | RNP>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Filter the resolve value:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Filter Resolve</button>
<p></p>
<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};
$( "button" ).on( "click", filterResolve );
</script>
</body>
</html>
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: null,
progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARD | ARP, AJD | AJP, AND | ANP,
BRD | BRP, BJD | BJP, BND | BNP,
CRD | CRP, CJD | CJP, CND | CNP,
RRD | RRP, RJD | RJP, RND | RNP>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: null,
failFilter: null,
progressFilter?: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method.
```javascript
$.get( "test.php" ).then(
function() {
alert( "$.get succeeded" );
}, function() {
alert( "$.get failed!" );
}
);
```
* @example ````Filter the resolve value:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Filter Resolve</button>
<p></p>
<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};
$( "button" ).on( "click", filterResolve );
</script>
</body>
</html>
```
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF,
progressFilter?: null): PromiseBase<ARD | ARF, AJD | AJF, AND | ANF,
BRD | BRF, BJD | BJF, BND | BNF,
CRD | CRF, CJD | CJF, CND | CNF,
RRD | RRF, RJD | RJF, RND | RNF>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
doneFilter: null,
failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF,
progressFilter?: null): PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Filter the resolve value:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Filter Resolve</button>
<p></p>
<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};
$( "button" ).on( "click", filterResolve );
</script>
</body>
</html>
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never>(
doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter?: null,
progressFilter?: null): PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND>;
// #endregion
/**
* Add handlers to be called when the Deferred object is rejected.
* @param failFilter A function that is called when the Deferred is rejected.
* @see \`{@link https://api.jquery.com/deferred.catch/ }\`
* @since 3.0
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can rejection handlers using the .catch method.
```javascript
$.get( "test.php" )
.then( function() {
alert( "$.get succeeded" );
} )
.catch( function() {
alert( "$.get failed!" );
} );
```
*/
catch<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
failFilter?: ((t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF) | null): PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF>;
}
/**
* This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred.
* @see \`{@link https://api.jquery.com/Types/#Promise }\`
*/
interface Promise3<TR, TJ, TN,
UR, UJ, UN,
VR, VJ, VN> extends PromiseBase<TR, TJ, TN,
UR, UJ, UN,
VR, VJ, VN,
never, never, never> { }
/**
* This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred.
* @see \`{@link https://api.jquery.com/Types/#Promise }\`
*/
interface Promise2<TR, TJ, TN,
UR, UJ, UN> extends PromiseBase<TR, TJ, TN,
UR, UJ, UN,
never, never, never,
never, never, never> { }
/**
* This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred.
* @see \`{@link https://api.jquery.com/Types/#Promise }\`
*/
interface Promise<TR, TJ = any, TN = any> extends PromiseBase<TR, TJ, TN,
TR, TJ, TN,
TR, TJ, TN,
TR, TJ, TN> { }
interface DeferredStatic {
// https://jquery.com/upgrade-guide/3.0/#callback-exit
exceptionHook: any;
/**
* A factory function that returns a chainable utility object with methods to register multiple callbacks into callback queues, invoke callback queues, and relay the success or failure state of any synchronous or asynchronous function.
* @param beforeStart A function that is called just before the constructor returns.
* @see \`{@link https://api.jquery.com/jQuery.Deferred/ }\`
* @since 1.5
*/
<TR = any, TJ = any, TN = any>(beforeStart?: (this: Deferred<TR, TJ, TN>, deferred: Deferred<TR, TJ, TN>) => void): Deferred<TR, TJ, TN>;
}
interface Deferred<TR, TJ = any, TN = any> {
/**
* Call the progressCallbacks on a Deferred object with the given args.
* @param args Optional arguments that are passed to the progressCallbacks.
* @see \`{@link https://api.jquery.com/deferred.notify/ }\`
* @since 1.7
*/
notify(...args: TN[]): this;
/**
* Call the progressCallbacks on a Deferred object with the given context and args.
* @param context Context passed to the progressCallbacks as the this object.
* @param args An optional array of arguments that are passed to the progressCallbacks.
* @see \`{@link https://api.jquery.com/deferred.notifyWith/ }\`
* @since 1.7
*/
notifyWith(context: object, args?: ArrayLike<TN>): this;
/**
* Reject a Deferred object and call any failCallbacks with the given args.
* @param args Optional arguments that are passed to the failCallbacks.
* @see \`{@link https://api.jquery.com/deferred.reject/ }\`
* @since 1.5
*/
reject(...args: TJ[]): this;
/**
* Reject a Deferred object and call any failCallbacks with the given context and args.
* @param context Context passed to the failCallbacks as the this object.
* @param args An optional array of arguments that are passed to the failCallbacks.
* @see \`{@link https://api.jquery.com/deferred.rejectWith/ }\`
* @since 1.5
*/
rejectWith(context: object, args?: ArrayLike<TJ>): this;
/**
* Resolve a Deferred object and call any doneCallbacks with the given args.
* @param args Optional arguments that are passed to the doneCallbacks.
* @see \`{@link https://api.jquery.com/deferred.resolve/ }\`
* @since 1.5
*/
resolve(...args: TR[]): this;
/**
* Resolve a Deferred object and call any doneCallbacks with the given context and args.
* @param context Context passed to the doneCallbacks as the this object.
* @param args An optional array of arguments that are passed to the doneCallbacks.
* @see \`{@link https://api.jquery.com/deferred.resolveWith/ }\`
* @since 1.5
*/
resolveWith(context: object, args?: ArrayLike<TR>): this;
/**
* Add handlers to be called when the Deferred object is either resolved or rejected.
* @param alwaysCallback A function, or array of functions, that is called when the Deferred is resolved or rejected.
* @param alwaysCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected.
* @see \`{@link https://api.jquery.com/deferred.always/ }\`
* @since 1.6
* @example ````Since the jQuery.get() method returns a jqXHR object, which is derived from a Deferred object, we can attach a callback for both success and error using the deferred.always() method.
```javascript
$.get( "test.php" ).always(function() {
alert( "$.get completed with success or error callback arguments" );
});
```
*/
always(alwaysCallback: TypeOrArray<Deferred.Callback<TR | TJ>>,
...alwaysCallbacks: Array<TypeOrArray<Deferred.Callback<TR | TJ>>>): this;
/**
* Add handlers to be called when the Deferred object is resolved.
* @param doneCallback A function, or array of functions, that are called when the Deferred is resolved.
* @param doneCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved.
* @see \`{@link https://api.jquery.com/deferred.done/ }\`
* @since 1.5
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach a success callback using the .done() method.
```javascript
$.get( "test.php" ).done(function() {
alert( "$.get succeeded" );
});
```
* @example ````Resolve a Deferred object when the user clicks a button, triggering a number of callback functions:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.done demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Go</button>
<p>Ready...</p>
<script>
// 3 functions to call when the Deferred object is resolved
function fn1() {
$( "p" ).append( " 1 " );
}
function fn2() {
$( "p" ).append( " 2 " );
}
function fn3( n ) {
$( "p" ).append( n + " 3 " + n );
}
// Create a deferred object
var dfd = $.Deferred();
// Add handlers to be called when dfd is resolved
dfd
// .done() can take any number of functions or arrays of functions
.done( [ fn1, fn2 ], fn3, [ fn2, fn1 ] )
// We can chain done methods, too
.done(function( n ) {
$( "p" ).append( n + " we're done." );
});
// Resolve the Deferred object when the button is clicked
$( "button" ).on( "click", function() {
dfd.resolve( "and" );
});
</script>
</body>
</html>
```
*/
done(doneCallback: TypeOrArray<Deferred.Callback<TR>>,
...doneCallbacks: Array<TypeOrArray<Deferred.Callback<TR>>>): this;
/**
* Add handlers to be called when the Deferred object is rejected.
* @param failCallback A function, or array of functions, that are called when the Deferred is rejected.
* @param failCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is rejected.
* @see \`{@link https://api.jquery.com/deferred.fail/ }\`
* @since 1.5
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred, you can attach a success and failure callback using the deferred.done() and deferred.fail() methods.
```javascript
$.get( "test.php" )
.done(function() {
alert( "$.get succeeded" );
})
.fail(function() {
alert( "$.get failed!" );
});
```
*/
fail(failCallback: TypeOrArray<Deferred.Callback<TJ>>,
...failCallbacks: Array<TypeOrArray<Deferred.Callback<TJ>>>): this;
/**
* Add handlers to be called when the Deferred object generates progress notifications.
* @param progressCallback A function, or array of functions, to be called when the Deferred generates progress notifications.
* @param progressCallbacks Optional additional functions, or arrays of functions, to be called when the Deferred generates
* progress notifications.
* @see \`{@link https://api.jquery.com/deferred.progress/ }\`
* @since 1.7
*/
progress(progressCallback: TypeOrArray<Deferred.Callback<TN>>,
...progressCallbacks: Array<TypeOrArray<Deferred.Callback<TN>>>): this;
/**
* Return a Deferred's Promise object.
* @param target Object onto which the promise methods have to be attached
* @see \`{@link https://api.jquery.com/deferred.promise/ }\`
* @since 1.5
* @example ````Use the target argument to promote an existing object to a Promise:
```javascript
// Existing object
var obj = {
hello: function( name ) {
alert( "Hello " + name );
}
},
// Create a Deferred
defer = $.Deferred();
// Set object as a promise
defer.promise( obj );
// Resolve the deferred
defer.resolve( "John" );
// Use the object as a Promise
obj.done(function( name ) {
obj.hello( name ); // Will alert "Hello John"
}).hello( "Karl" ); // Will alert "Hello Karl"
```
*/
promise<TTarget extends object>(target: TTarget): Promise<TR, TJ, TN> & TTarget;
/**
* Return a Deferred's Promise object.
* @see \`{@link https://api.jquery.com/deferred.promise/ }\`
* @since 1.5
* @example ````Create a Deferred and set two timer-based functions to either resolve or reject the Deferred after a random interval. Whichever one fires first "wins" and will call one of the callbacks. The second timeout has no effect since the Deferred is already complete (in a resolved or rejected state) from the first timeout action. Also set a timer-based progress notification function, and call a progress handler that adds "working..." to the document body.
```javascript
function asyncEvent() {
var dfd = jQuery.Deferred();
// Resolve after a random interval
setTimeout(function() {
dfd.resolve( "hurray" );
}, Math.floor( 400 + Math.random() * 2000 ) );
// Reject after a random interval
setTimeout(function() {
dfd.reject( "sorry" );
}, Math.floor( 400 + Math.random() * 2000 ) );
// Show a "working..." message every half-second
setTimeout(function working() {
if ( dfd.state() === "pending" ) {
dfd.notify( "working... " );
setTimeout( working, 500 );
}
}, 1 );
// Return the Promise so caller can't change the Deferred
return dfd.promise();
}
// Attach a done, fail, and progress handler for the asyncEvent
$.when( asyncEvent() ).then(
function( status ) {
alert( status + ", things are going well" );
},
function( status ) {
alert( status + ", you fail this time" );
},
function( status ) {
$( "body" ).append( status );
}
);
```
*/
promise(): Promise<TR, TJ, TN>;
/**
* Determine the current state of a Deferred object.
* @see \`{@link https://api.jquery.com/deferred.state/ }\`
* @since 1.7
*/
state(): 'pending' | 'resolved' | 'rejected';
// region pipe
// #region pipe
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter resolve value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: (...t: TR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: (...t: TJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<AJF> | AJF,
progressFilter: (...t: TN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARD | ARF | ARP, AJD | AJF | AJP, AND | ANF | ANP,
BRD | BRF | BRP, BJD | BJF | BJP, BND | BNF | BNP,
CRD | CRF | CRP, CJD | CJF | CJP, CND | CNF | CNP,
RRD | RRF | RRP, RJD | RJF | RJP, RND | RNF | RNP>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: null,
failFilter: (...t: TJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<AJF> | AJF,
progressFilter: (...t: TN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARF | ARP, AJF | AJP, ANF | ANP,
BRF | BRP, BJF | BJP, BNF | BNP,
CRF | CRP, CJF | CJP, CNF | CNP,
RRF | RRP, RJF | RJP, RNF | RNP>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter resolve value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: (...t: TR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: null,
progressFilter: (...t: TN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARD | ARP, AJD | AJP, AND | ANP,
BRD | BRP, BJD | BJP, BND | BNP,
CRD | CRP, CJD | CJP, CND | CNP,
RRD | RRP, RJD | RJP, RND | RNP>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: null,
failFilter: null,
progressFilter?: (...t: TN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter resolve value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
doneFilter: (...t: TR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: (...t: TJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<AJF> | AJF,
progressFilter?: null): PromiseBase<ARD | ARF, AJD | AJF, AND | ANF,
BRD | BRF, BJD | BJF, BND | BNF,
CRD | CRF, CJD | CJF, CND | CNF,
RRD | RRF, RJD | RJF, RND | RNF>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
doneFilter: null,
failFilter: (...t: TJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<AJF> | AJF,
progressFilter?: null): PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF>;
/**
* Utility method to filter and/or chain Deferreds.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.pipe/ }\`
* @since 1.6
* @since 1.7
* @deprecated Deprecated since 1.8. Use \`{@link then }\`.
*
* **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
*
* **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0.
* @example ````Filter resolve value:
```javascript
var defer = $.Deferred(),
filtered = defer.pipe(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
alert( "Value is ( 2*5 = ) 10: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.pipe(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
pipe<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never>(
doneFilter: (...t: TR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter?: null,
progressFilter?: null): PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND>;
// #endregion
// region then
// #region then
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter A function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method.
```javascript
$.get( "test.php" ).then(
function() {
alert( "$.get succeeded" );
}, function() {
alert( "$.get failed!" );
}
);
```
* @example ````Filter the resolve value:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Filter Resolve</button>
<p></p>
<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};
$( "button" ).on( "click", filterResolve );
</script>
</body>
</html>
```
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: (...t: TR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: (...t: TJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF,
progressFilter: (...t: TN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARD | ARF | ARP, AJD | AJF | AJP, AND | ANF | ANP,
BRD | BRF | BRP, BJD | BJF | BJP, BND | BNF | BNP,
CRD | CRF | CRP, CJD | CJF | CJP, CND | CNF | CNP,
RRD | RRF | RRP, RJD | RJF | RJP, RND | RNF | RNP>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter A function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: null,
failFilter: (...t: TJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF,
progressFilter: (...t: TN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARF | ARP, AJF | AJP, ANF | ANP,
BRF | BRP, BJF | BJP, BNF | BNP,
CRF | CRP, CJF | CJP, CNF | CNP,
RRF | RRP, RJF | RJP, RNF | RNP>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter A function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Filter the resolve value:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Filter Resolve</button>
<p></p>
<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};
$( "button" ).on( "click", filterResolve );
</script>
</body>
</html>
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: (...t: TR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: null,
progressFilter: (...t: TN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARD | ARP, AJD | AJP, AND | ANP,
BRD | BRP, BJD | BJP, BND | BNP,
CRD | CRP, CJD | CJP, CND | CNP,
RRD | RRP, RJD | RJP, RND | RNP>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter A function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARP = never, AJP = never, ANP = never,
BRP = never, BJP = never, BNP = never,
CRP = never, CJP = never, CNP = never,
RRP = never, RJP = never, RNP = never>(
doneFilter: null,
failFilter: null,
progressFilter?: (...t: TN[]) => PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP> | Thenable<ANP> | ANP): PromiseBase<ARP, AJP, ANP,
BRP, BJP, BNP,
CRP, CJP, CNP,
RRP, RJP, RNP>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method.
```javascript
$.get( "test.php" ).then(
function() {
alert( "$.get succeeded" );
}, function() {
alert( "$.get failed!" );
}
);
```
* @example ````Filter the resolve value:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Filter Resolve</button>
<p></p>
<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};
$( "button" ).on( "click", filterResolve );
</script>
</body>
</html>
```
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never,
ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
doneFilter: (...t: TR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter: (...t: TJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF,
progressFilter?: null): PromiseBase<ARD | ARF, AJD | AJF, AND | ANF,
BRD | BRF, BJD | BJF, BND | BNF,
CRD | CRF, CJD | CJF, CND | CNF,
RRD | RRF, RJD | RJF, RND | RNF>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Filter reject value:
```javascript
var defer = $.Deferred(),
filtered = defer.then( null, function( value ) {
return value * 3;
});
defer.reject( 6 );
filtered.fail(function( value ) {
alert( "Value is ( 3*6 = ) 18: " + value );
});
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
doneFilter: null,
failFilter: (...t: TJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF,
progressFilter?: null): PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF>;
/**
* Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
* @param doneFilter An optional function that is called when the Deferred is resolved.
* @param failFilter An optional function that is called when the Deferred is rejected.
* @param progressFilter An optional function that is called when progress notifications are sent to the Deferred.
* @see \`{@link https://api.jquery.com/deferred.then/ }\`
* @since 1.8
* @example ````Filter the resolve value:
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>deferred.then demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>Filter Resolve</button>
<p></p>
<script>
var filterResolve = function() {
var defer = $.Deferred(),
filtered = defer.then(function( value ) {
return value * 2;
});
defer.resolve( 5 );
filtered.done(function( value ) {
$( "p" ).html( "Value is ( 2*5 = ) 10: " + value );
});
};
$( "button" ).on( "click", filterResolve );
</script>
</body>
</html>
```
* @example ````Chain tasks:
```javascript
var request = $.ajax( url, { dataType: "json" } ),
chained = request.then(function( data ) {
return $.ajax( url2, { data: { user: data.userId } } );
});
chained.done(function( data ) {
// data retrieved from url2 as provided by the first request
});
```
*/
then<ARD = never, AJD = never, AND = never,
BRD = never, BJD = never, BND = never,
CRD = never, CJD = never, CND = never,
RRD = never, RJD = never, RND = never>(
doneFilter: (...t: TR[]) => PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND> | Thenable<ARD> | ARD,
failFilter?: null,
progressFilter?: null): PromiseBase<ARD, AJD, AND,
BRD, BJD, BND,
CRD, CJD, CND,
RRD, RJD, RND>;
// #endregion
/**
* Add handlers to be called when the Deferred object is rejected.
* @param failFilter A function that is called when the Deferred is rejected.
* @see \`{@link https://api.jquery.com/deferred.catch/ }\`
* @since 3.0
* @example ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can rejection handlers using the .catch method.
```javascript
$.get( "test.php" )
.then( function() {
alert( "$.get succeeded" );
} )
.catch( function() {
alert( "$.get failed!" );
} );
```
*/
catch<ARF = never, AJF = never, ANF = never,
BRF = never, BJF = never, BNF = never,
CRF = never, CJF = never, CNF = never,
RRF = never, RJF = never, RNF = never>(
failFilter?: ((...t: TJ[]) => PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF> | Thenable<ARF> | ARF) | null): PromiseBase<ARF, AJF, ANF,
BRF, BJF, BNF,
CRF, CJF, CNF,
RRF, RJF, RNF>;
}
namespace Deferred {
type CallbackBase<T, U, V, R> = (t: T, u: U, v: V, ...r: R[]) => void;
interface Callback3<T, U, V> extends CallbackBase<T, U, V, never> { }
type Callback<T> = (...args: T[]) => void;
/**
* @deprecated Deprecated. Use \`{@link Callback }\`.
*/
interface DoneCallback<TResolve> extends Callback<TResolve> { }
/**
* @deprecated Deprecated. Use \`{@link Callback }\`.
*/
interface FailCallback<TReject> extends Callback<TReject> { }
/**
* @deprecated Deprecated. Use \`{@link Callback }\`.
*/
interface AlwaysCallback<TResolve, TReject> extends Callback<TResolve | TReject> { }
/**
* @deprecated Deprecated. Use \`{@link Callback }\`.
*/
interface ProgressCallback<TNotify> extends Callback<TNotify> { }
}
// #endregion
// region Effects
// #region Effects
type Duration = number | 'fast' | 'slow';
/**
* @see \`{@link https://api.jquery.com/animate/#animate-properties-options }\`
*/
interface EffectsOptions<TElement> extends PlainObject {
/**
* A function to be called when the animation on an element completes or stops without completing (its Promise object is either resolved or rejected).
*/
always?(this: TElement, animation: Animation<TElement>, jumpedToEnd: boolean): void;
/**
* A function that is called once the animation on an element is complete.
*/
complete?(this: TElement): void;
/**
* A function to be called when the animation on an element completes (its Promise object is resolved).
*/
done?(this: TElement, animation: Animation<TElement>, jumpedToEnd: boolean): void;
/**
* A string or number determining how long the animation will run.
*/
duration?: Duration;
/**
* A string indicating which easing function to use for the transition.
*/
easing?: string;
/**
* A function to be called when the animation on an element fails to complete (its Promise object is rejected).
*/
fail?(this: TElement, animation: Animation<TElement>, jumpedToEnd: boolean): void;
/**
* A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties.
*/
progress?(this: TElement, animation: Animation<TElement>, progress: number, remainingMs: number): void;
/**
* A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. As of jQuery 1.7, the queue option can also accept a string, in which case the animation is added to the queue represented by that string. When a custom queue name is used the animation does not automatically start; you must call .dequeue("queuename") to start it.
*/
queue?: boolean | string;
/**
* An object containing one or more of the CSS properties defined by the properties argument and their corresponding easing functions.
*/
specialEasing?: PlainObject<string>;
/**
* A function to call when the animation on an element begins.
*/
start?(this: TElement, animation: Animation<TElement>): void;
/**
* A function to be called for each animated property of each animated element. This function provides an opportunity to modify the Tween object to change the value of the property before it is set.
*/
step?(this: TElement, now: number, tween: Tween<TElement>): void;
}
// region Animation
// #region Animation
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
interface AnimationStatic {
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
<TElement>(element: TElement, props: PlainObject, opts: EffectsOptions<TElement>): Animation<TElement>;
/**
* During the initial setup, `jQuery.Animation` will call any callbacks that have been registered through `jQuery.Animation.prefilter( function( element, props, opts ) )`.
* @param callback The prefilter will have `this` set to an animation object, and you can modify any of the `props` or
* `opts` however you need. The prefilter _may_ return its own promise which also implements `stop()`,
* in which case, processing of prefilters stops. If the prefilter is not trying to override the animation
* entirely, it should return `undefined` or some other falsy value.
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#prefilters }\`
* @since 1.8
*/
prefilter<TElement>(
callback: (this: Animation<TElement>, element: TElement, props: PlainObject, opts: EffectsOptions<TElement>) => Animation<TElement> | _Falsy | void,
prepend?: boolean
): void;
/**
* A "Tweener" is a function responsible for creating a tween object, and you might want to override these if you want to implement complex values ( like a clip/transform array matrix ) in a single property.
*
* You can override the default process for creating a tween in order to provide your own tween object by using `jQuery.Animation.tweener( props, callback( prop, value ) )`.
* @param props A space separated list of properties to be passed to your tweener, or `"*"` if it should be called
* for all properties.
* @param callback The callback will be called with `this` being an `Animation` object. The tweener function will
* generally start with `var tween = this.createTween( prop, value );`, but doesn't nessecarily need to
* use the `jQuery.Tween()` factory.
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweeners }\`
* @since 1.8
*/
tweener(props: string, callback: Tweener<any>): void;
}
/**
* The promise will be resolved when the animation reaches its end, and rejected when terminated early. The context of callbacks attached to the promise will be the element, and the arguments will be the `Animation` object and a boolean `jumpedToEnd` which when true means the animation was stopped with `gotoEnd`, when `undefined` the animation completed naturally.
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
interface Animation<TElement> extends Promise3<
Animation<TElement>, Animation<TElement>, Animation<TElement>,
true | undefined, false, number,
never, never, number
> {
/**
* The duration specified in ms
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
duration: number;
/**
* The element being animatied
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
elem: TElement;
/**
* The final value of each property animating
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
props: PlainObject;
/**
* The animation options
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
opts: EffectsOptions<TElement>;
/**
* The original properties before being filtered
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
originalProps: PlainObject;
/**
* The original options before being filtered
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
originalOpts: EffectsOptions<TElement>;
/**
* The numeric value of `new Date()` when the animation began
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
startTime: number;
/**
* The animations tweens.
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
tweens: Array<Tween<TElement>>;
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
createTween(propName: string, finalValue: number): Tween<TElement>;
/**
* Stops the animation early, optionally going to the end.
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\`
* @since 1.8
*/
stop(gotoEnd: boolean): this;
}
/**
* A "Tweener" is a function responsible for creating a tween object, and you might want to override these if you want to implement complex values ( like a clip/transform array matrix ) in a single property.
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweeners }\`
* @since 1.8
*/
type Tweener<TElement> = (this: Animation<TElement>, propName: string, finalValue: number) => Tween<TElement>;
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
interface TweenStatic {
/**
* `jQuery.Tween.propHooks[ prop ]` is a hook point that replaces `jQuery.fx.step[ prop ]` (which is being deprecated.) These hooks are used by the tween to get and set values on elements.
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\`
* @since 1.8
* @example
```javascript
jQuery.Tween.propHooks[ property ] = {
get: function( tween ) {
// get tween.prop from tween.elem and return it
},
set: function( tween ) {
// set tween.prop on tween.elem to tween.now + tween.unit
}
}
```
*/
propHooks: PropHooks;
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
<TElement>(elem: TElement, options: EffectsOptions<TElement>, prop: string, end: number, easing?: string, unit?: string): Tween<TElement>;
}
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
// This should be a class but doesn't work correctly under the JQuery namespace. Tween should be an inner class of jQuery.
interface Tween<TElement> {
/**
* The easing used
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
easing: string;
/**
* The element being animated
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
elem: TElement;
/**
* The ending value of the tween
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
end: number;
/**
* The current value of the tween
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
now: number;
/**
* A reference to the animation options
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
options: EffectsOptions<TElement>;
// Undocumented. Is this intended to be public?
pos?: number;
/**
* The property being animated
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
prop: string;
/**
* The starting value of the tween
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
start: number;
/**
* The CSS unit for the tween
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
unit: string;
/**
* Reads the current value for property from the element
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
cur(): any;
/**
* Updates the value for the property on the animated elemd.
* @param progress A number from 0 to 1.
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\`
* @since 1.8
*/
run(progress: number): this;
}
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\`
* @since 1.8
*/
// Workaround for TypeScript 2.3 which does not have support for weak types handling.
type PropHook<TElement> = {
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\`
* @since 1.8
*/
get(tween: Tween<TElement>): any;
} | {
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\`
* @since 1.8
*/
set(tween: Tween<TElement>): void;
} | {
[key: string]: never;
};
/**
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\`
* @since 1.8
*/
interface PropHooks {
[property: string]: PropHook<Node>;
}
// #endregion
// region Easing
// #region Easing
type EasingMethod = (percent: number) => number;
interface Easings {
[name: string]: EasingMethod;
}
// #endregion
// region Effects (fx)
// #region Effects (fx)
interface Effects {
/**
* The rate (in milliseconds) at which animations fire.
* @see \`{@link https://api.jquery.com/jQuery.fx.interval/ }\`
* @since 1.4.3
* @deprecated Deprecated since 3.0. See \`{@link https://api.jquery.com/jQuery.fx.interval/ }\`.
*
* **Cause**: As of jQuery 3.0 the `jQuery.fx.interval` property can be used to change the animation interval only on browsers that do not support the `window.requestAnimationFrame()` method. That is currently only Internet Explorer 9 and the Android Browser. Once support is dropped for these browsers, the property will serve no purpose and it will be removed.
*
* **Solution**: Find and remove code that changes or uses `jQuery.fx.interval`. If the value is being used by code in your page or a plugin, the code may be making assumptions that are no longer valid. The default value of `jQuery.fx.interval` is `13` (milliseconds), which could be used instead of accessing this property.
* @example ````Cause all animations to run with less frames.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>jQuery.fx.interval demo</title>
<style>
div {
width: 50px;
height: 30px;
margin: 5px;
float: left;
background: green;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<p><input type="button" value="Run"></p>
<div></div>
<script>
jQuery.fx.interval = 100;
$( "input" ).click(function() {
$( "div" ).toggle( 3000 );
});
</script>
</body>
</html>
```
*/
interval: number;
/**
* Globally disable all animations.
* @see \`{@link https://api.jquery.com/jQuery.fx.off/ }\`
* @since 1.3
* @example ````Toggle animation on and off
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>jQuery.fx.off demo</title>
<style>
div {
width: 50px;
height: 30px;
margin: 5px;
float: left;
background: green;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input type="button" value="Run">
<button>Toggle fx</button>
<div></div>
<script>
var toggleFx = function() {
$.fx.off = !$.fx.off;
};
toggleFx();
$( "button" ).click( toggleFx );
$( "input" ).click(function() {
$( "div" ).toggle( "slow" );
});
</script>
</body>
</html>
```
*/
off: boolean;
/**
* @deprecated Deprecated since 1.8. Use \`{@link Tween.propHooks jQuery.Tween.propHooks}\`.
*
* `jQuery.fx.step` functions are being replaced by `jQuery.Tween.propHooks` and may eventually be removed, but are still supported via the default tween propHook.
*/
step: PlainObject<AnimationHook<Node>>;
/**
* _overridable_ Clears up the `setInterval`
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#plugging-in-a-different-timer-loop }\`
* @since 1.8
*/
stop(): void;
/**
* Calls `.run()` on each object in the `jQuery.timers` array, removing it from the array if `.run()` returns a falsy value. Calls `jQuery.fx.stop()` whenever there are no timers remaining.
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#plugging-in-a-different-timer-loop }\`
* @since 1.8
*/
tick(): void;
/**
* _overridable_ Creates a `setInterval` if one doesn't already exist, and pushes `tickFunction` to the `jQuery.timers` array. `tickFunction` should also have `anim`, `elem`, and `queue` properties that reference the animation object, animated element, and queue option to facilitate `jQuery.fn.stop()`
*
* By overriding `fx.timer` and `fx.stop` you should be able to implement any animation tick behaviour you desire. (like using `requestAnimationFrame` instead of `setTimeout`.)
*
* There is an example of overriding the timer loop in \`{@link https://github.com/gnarf37/jquery-requestAnimationFrame jquery.requestAnimationFrame}\`
* @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#plugging-in-a-different-timer-loop }\`
* @since 1.8
*/
timer(tickFunction: TickFunction<any>): void;
}
/**
* @deprecated Deprecated since 1.8. Use \`{@link Tween.propHooks jQuery.Tween.propHooks}\`.
*
* `jQuery.fx.step` functions are being replaced by `jQuery.Tween.propHooks` and may eventually be removed, but are still supported via the default tween propHook.
*/
type AnimationHook<TElement> = (fx: Tween<TElement>) => void;
interface TickFunction<TElement> {
anim: Animation<TElement>;
elem: TElement;
queue: boolean | string;
(): any;
}
// #endregion
// region Queue
// #region Queue
// TODO: Is the first element always a string or is that specific to the 'fx' queue?
type Queue<TElement> = { 0: string; } & Array<QueueFunction<TElement>>;
type QueueFunction<TElement> = (this: TElement, next: () => void) => void;
// #endregion
// region Speed
// #region Speed
// Workaround for TypeScript 2.3 which does not have support for weak types handling.
type SpeedSettings<TElement> = {
/**
* A string or number determining how long the animation will run.
*/
duration: Duration;
} | {
/**
* A string indicating which easing function to use for the transition.
*/
easing: string;
} | {
/**
* A function to call once the animation is complete.
*/
complete(this: TElement): void;
} | {
[key: string]: never;
};
// #endregion
// #endregion
// region Events
// #region Events
// region Event
// #region Event
// This should be a class but doesn't work correctly under the JQuery namespace. Event should be an inner class of jQuery.
/**
* jQuery's event system normalizes the event object according to W3C standards. The event object is guaranteed to be passed to the event handler (no checks for window.event required). It normalizes the target, relatedTarget, which, metaKey and pageX/Y properties and provides both stopPropagation() and preventDefault() methods.
*
* Those properties are all documented, and accompanied by examples, on the \`{@link http://api.jquery.com/category/events/event-object/ Event object}\` page.
*
* The standard events in the Document Object Model are: `blur`, `focus`, `load`, `resize`, `scroll`, `unload`, `beforeunload`, `click`, `dblclick`, `mousedown`, `mouseup`, `mousemove`, `mouseover`, `mouseout`, `mouseenter`, `mouseleave`, `change`, `select`, `submit`, `keydown`, `keypress`, and `keyup`. Since the DOM event names have predefined meanings for some elements, using them for other purposes is not recommended. jQuery's event model can trigger an event by any name on an element, and it is propagated up the DOM tree to which that element belongs, if any.
* @see \`{@link https://api.jquery.com/category/events/event-object/ }\`
*/
interface EventStatic {
/**
* The jQuery.Event constructor is exposed and can be used when calling trigger. The new operator is optional.
*
* Check \`{@link https://api.jquery.com/trigger/ trigger}\`'s documentation to see how to combine it with your own event object.
* @see \`{@link https://api.jquery.com/category/events/event-object/ }\`
* @since 1.6
* @example
```javascript
//Create a new jQuery.Event object without the "new" operator.
var e = jQuery.Event( "click" );
// trigger an artificial click event
jQuery( "body" ).trigger( e );
```
* @example
```javascript
// Create a new jQuery.Event object with specified event properties.
var e = jQuery.Event( "keydown", { keyCode: 64 } );
// trigger an artificial keydown event with keyCode 64
jQuery( "body" ).trigger( e );
```
*/
<T extends object>(event: string, properties?: T): Event & T;
/**
* The jQuery.Event constructor is exposed and can be used when calling trigger. The new operator is optional.
*
* Check \`{@link https://api.jquery.com/trigger/ trigger}\`'s documentation to see how to combine it with your own event object.
* @see \`{@link https://api.jquery.com/category/events/event-object/ }\`
* @since 1.6
* @example
```javascript
//Create a new jQuery.Event object without the "new" operator.
var e = jQuery.Event( "click" );
// trigger an artificial click event
jQuery( "body" ).trigger( e );
```
* @example
```javascript
// Create a new jQuery.Event object with specified event properties.
var e = jQuery.Event( "keydown", { keyCode: 64 } );
// trigger an artificial keydown event with keyCode 64
jQuery( "body" ).trigger( e );
```
*/
new <T extends object>(event: string, properties?: T): Event & T;
}
/**
* jQuery's event system normalizes the event object according to W3C standards. The event object is guaranteed to be passed to the event handler (no checks for window.event required). It normalizes the target, relatedTarget, which, metaKey and pageX/Y properties and provides both stopPropagation() and preventDefault() methods.
*
* Those properties are all documented, and accompanied by examples, on the \`{@link http://api.jquery.com/category/events/event-object/ Event object}\` page.
*
* The standard events in the Document Object Model are: `blur`, `focus`, `load`, `resize`, `scroll`, `unload`, `beforeunload`, `click`, `dblclick`, `mousedown`, `mouseup`, `mousemove`, `mouseover`, `mouseout`, `mouseenter`, `mouseleave`, `change`, `select`, `submit`, `keydown`, `keypress`, and `keyup`. Since the DOM event names have predefined meanings for some elements, using them for other purposes is not recommended. jQuery's event model can trigger an event by any name on an element, and it is propagated up the DOM tree to which that element belongs, if any.
* @see \`{@link https://api.jquery.com/category/events/event-object/ }\`
* @see \`{@link TriggeredEvent }\`
*/
interface Event {
// region Copied properties
// #region Copied properties
// Event
bubbles: boolean | undefined;
cancelable: boolean | undefined;
eventPhase: number | undefined;
// UIEvent
detail: number | undefined;
view: Window | undefined;
// MouseEvent
button: number | undefined;
buttons: number | undefined;
clientX: number | undefined;
clientY: number | undefined;
offsetX: number | undefined;
offsetY: number | undefined;
/**
* The mouse position relative to the left edge of the document.
* @see \`{@link https://api.jquery.com/event.pageX/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageX demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageX: number | undefined;
/**
* The mouse position relative to the top edge of the document.
* @see \`{@link https://api.jquery.com/event.pageY/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageY demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageY: number | undefined;
screenX: number | undefined;
screenY: number | undefined;
/** @deprecated */
toElement: Element | undefined;
// PointerEvent
pointerId: number | undefined;
pointerType: string | undefined;
// KeyboardEvent
/** @deprecated */
char: string | undefined;
/** @deprecated */
charCode: number | undefined;
key: string | undefined;
/** @deprecated */
keyCode: number | undefined;
// TouchEvent
changedTouches: TouchList | undefined;
targetTouches: TouchList | undefined;
touches: TouchList | undefined;
// MouseEvent, KeyboardEvent
/**
* For key or mouse events, this property indicates the specific key or button that was pressed.
* @see \`{@link https://api.jquery.com/event.which/ }\`
* @since 1.1.3
* @example ````Log which key was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="type something">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "keydown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
* @example ````Log which mouse button was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="click here">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "mousedown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
*/
which: number | undefined;
// MouseEvent, KeyboardEvent, TouchEvent
altKey: boolean | undefined;
ctrlKey: boolean | undefined;
/**
* Indicates whether the META key was pressed when the event fired.
* @see \`{@link https://api.jquery.com/event.metaKey/ }\`
* @since 1.0.4
* @example ````Determine whether the META key was pressed when the event fired.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.metaKey demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button value="Test" name="Test" id="checkMetaKey">Click me!</button>
<div id="display"></div>
<script>
$( "#checkMetaKey" ).click(function( event ) {
$( "#display" ).text( event.metaKey );
});
</script>
</body>
</html>
```
*/
metaKey: boolean | undefined;
shiftKey: boolean | undefined;
// #endregion
/**
* The difference in milliseconds between the time the browser created the event and January 1, 1970.
* @see \`{@link https://api.jquery.com/event.timeStamp/ }\`
* @since 1.2.6
* @example ````Display the time since the click handler last executed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.timeStamp demo</title>
<style>
div {
height: 100px;
width: 300px;
margin: 10px;
background-color: #ffd;
overflow: auto;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div>Click.</div>
<script>
var last, diff;
$( "div" ).click(function( event ) {
if ( last ) {
diff = event.timeStamp - last;
$( "div" ).append( "time since last event: " + diff + "<br>" );
} else {
$( "div" ).append( "Click again.<br>" );
}
last = event.timeStamp;
});
</script>
</body>
</html>
```
*/
timeStamp: number;
/**
* Describes the nature of the event.
* @see \`{@link https://api.jquery.com/event.type/ }\`
* @since 1.0
* @example ````On all anchor clicks, alert the event type.
```javascript
$( "a" ).click(function( event ) {
alert( event.type ); // "click"
});
```
*/
type: string;
/**
* Returns whether event.preventDefault() was ever called on this event object.
* @see \`{@link https://api.jquery.com/event.isDefaultPrevented/ }\`
* @since 1.3
* @example ````Checks whether event.preventDefault() was called.
```javascript
$( "a" ).click(function( event ) {
alert( event.isDefaultPrevented() ); // false
event.preventDefault();
alert( event.isDefaultPrevented() ); // true
});
```
*/
isDefaultPrevented(): boolean;
/**
* Returns whether event.stopImmediatePropagation() was ever called on this event object.
* @see \`{@link https://api.jquery.com/event.isImmediatePropagationStopped/ }\`
* @since 1.3
* @example ````Checks whether event.stopImmediatePropagation() was called.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.isImmediatePropagationStopped demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>click me</button>
<div id="stop-log"></div>
<script>
function immediatePropStopped( event ) {
var msg = "";
if ( event.isImmediatePropagationStopped() ) {
msg = "called";
} else {
msg = "not called";
}
$( "#stop-log" ).append( "<div>" + msg + "</div>" );
}
$( "button" ).click(function( event ) {
immediatePropStopped( event );
event.stopImmediatePropagation();
immediatePropStopped( event );
});
</script>
</body>
</html>
```
*/
isImmediatePropagationStopped(): boolean;
/**
* Returns whether event.stopPropagation() was ever called on this event object.
* @see \`{@link https://api.jquery.com/event.isPropagationStopped/ }\`
* @since 1.3
* @example ````Checks whether event.stopPropagation() was called
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.isPropagationStopped demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>click me</button>
<div id="stop-log"></div>
<script>
function propStopped( event ) {
var msg = "";
if ( event.isPropagationStopped() ) {
msg = "called";
} else {
msg = "not called";
}
$( "#stop-log" ).append( "<div>" + msg + "</div>" );
}
$( "button" ).click(function(event) {
propStopped( event );
event.stopPropagation();
propStopped( event );
});
</script>
</body>
</html>
```
*/
isPropagationStopped(): boolean;
/**
* If this method is called, the default action of the event will not be triggered.
* @see \`{@link https://api.jquery.com/event.preventDefault/ }\`
* @since 1.0
* @example ````Cancel the default action (navigation) of the click.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.preventDefault demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<a href="https://jquery.com">default click action is prevented</a>
<div id="log"></div>
<script>
$( "a" ).click(function( event ) {
event.preventDefault();
$( "<div>" )
.append( "default " + event.type + " prevented" )
.appendTo( "#log" );
});
</script>
</body>
</html>
```
*/
preventDefault(): void;
/**
* Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.
* @see \`{@link https://api.jquery.com/event.stopImmediatePropagation/ }\`
* @since 1.3
* @example ````Prevents other event handlers from being called.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.stopImmediatePropagation demo</title>
<style>
p {
height: 30px;
width: 150px;
background-color: #ccf;
}
div {
height: 30px;
width: 150px;
background-color: #cfc;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<p>paragraph</p>
<div>division</div>
<script>
$( "p" ).click(function( event ) {
event.stopImmediatePropagation();
});
$( "p" ).click(function( event ) {
// This function won't be executed
$( this ).css( "background-color", "#f00" );
});
$( "div" ).click(function( event ) {
// This function will be executed
$( this ).css( "background-color", "#f00" );
});
</script>
</body>
</html>
```
*/
stopImmediatePropagation(): void;
/**
* Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.
* @see \`{@link https://api.jquery.com/event.stopPropagation/ }\`
* @since 1.0
* @example ````Kill the bubbling on the click event.
```javascript
$( "p" ).click(function( event ) {
event.stopPropagation();
// Do something
});
```
*/
stopPropagation(): void;
}
// #endregion
/**
* Base type for jQuery events that have been triggered (including events triggered on plain objects).
*/
interface TriggeredEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends Event {
/**
* The current DOM element within the event bubbling phase.
* @see \`{@link https://api.jquery.com/event.currentTarget/ }\`
* @since 1.3
* @example ````Alert that currentTarget matches the `this` keyword.
```javascript
$( "p" ).click(function( event ) {
alert( event.currentTarget === this ); // true
});
```
*/
currentTarget: TCurrentTarget;
/**
* The element where the currently-called jQuery event handler was attached.
* @see \`{@link https://api.jquery.com/event.delegateTarget/ }\`
* @since 1.7
* @example ````When a button in any box class is clicked, change the box's background color to red.
```javascript
$( ".box" ).on( "click", "button", function( event ) {
$( event.delegateTarget ).css( "background-color", "red" );
});
```
*/
delegateTarget: TDelegateTarget;
/**
* The DOM element that initiated the event.
* @see \`{@link https://api.jquery.com/event.target/ }\`
* @since 1.0
* @example ````Display the tag's name on click
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.target demo</title>
<style>
span, strong, p {
padding: 8px;
display: block;
border: 1px solid #999;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<div>
<p>
<strong><span>click</span></strong>
</p>
</div>
<script>
$( "body" ).click(function( event ) {
$( "#log" ).html( "clicked: " + event.target.nodeName );
});
</script>
</body>
</html>
```
* @example ````Implements a simple event delegation: The click handler is added to an unordered list, and the children of its li children are hidden. Clicking one of the li children toggles (see toggle()) their children.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.target demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<ul>
<li>item 1
<ul>
<li>sub item 1-a</li>
<li>sub item 1-b</li>
</ul>
</li>
<li>item 2
<ul>
<li>sub item 2-a</li>
<li>sub item 2-b</li>
</ul>
</li>
</ul>
<script>
function handler( event ) {
var target = $( event.target );
if ( target.is( "li" ) ) {
target.children().toggle();
}
}
$( "ul" ).click( handler ).find( "ul" ).hide();
</script>
</body>
</html>
```
*/
target: TTarget;
/**
* An optional object of data passed to an event method when the current executing handler is bound.
* @see \`{@link https://api.jquery.com/event.data/ }\`
* @since 1.1
* @example ````Within a for loop, pass the value of i to the .on() method so that the current iteration's value is preserved.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.data demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button> 0 </button>
<button> 1 </button>
<button> 2 </button>
<button> 3 </button>
<button> 4 </button>
<div id="log"></div>
<script>
var logDiv = $( "#log" );
for ( var i = 0; i < 5; i++ ) {
$( "button" ).eq( i ).on( "click", { value: i }, function( event ) {
var msgs = [
"button = " + $( this ).index(),
"event.data.value = " + event.data.value,
"i = " + i
];
logDiv.append( msgs.join( ", " ) + "<br>" );
});
}
</script>
</body>
</html>
```
*/
data: TData;
/**
* The namespace specified when the event was triggered.
* @see \`{@link https://api.jquery.com/event.namespace/ }\`
* @since 1.4.3
* @example ````Determine the event namespace used.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.namespace demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>display event.namespace</button>
<p></p>
<script>
$( "p" ).on( "test.something", function( event ) {
alert( event.namespace );
});
$( "button" ).click(function( event ) {
$( "p" ).trigger( "test.something" );
});
</script>
</body>
</html>
```
*/
namespace?: string;
originalEvent?: _Event;
/**
* The last value returned by an event handler that was triggered by this event, unless the value was undefined.
* @see \`{@link https://api.jquery.com/event.result/ }\`
* @since 1.3
* @example ````Display previous handler's return value
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.result demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button>display event.result</button>
<p></p>
<script>
$( "button" ).click(function( event ) {
return "hey";
});
$( "button" ).click(function( event ) {
$( "p" ).html( event.result );
});
</script>
</body>
</html>
```
*/
result?: any;
}
// region Event
// #region Event
interface EventBase<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends TriggeredEvent<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: undefined;
// Event
bubbles: boolean;
cancelable: boolean;
eventPhase: number;
// UIEvent
detail: undefined;
view: undefined;
// MouseEvent
button: undefined;
buttons: undefined;
clientX: undefined;
clientY: undefined;
offsetX: undefined;
offsetY: undefined;
/**
* The mouse position relative to the left edge of the document.
* @see \`{@link https://api.jquery.com/event.pageX/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageX demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageX: undefined;
/**
* The mouse position relative to the top edge of the document.
* @see \`{@link https://api.jquery.com/event.pageY/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageY demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageY: undefined;
screenX: undefined;
screenY: undefined;
/** @deprecated */
toElement: undefined;
// PointerEvent
pointerId: undefined;
pointerType: undefined;
// KeyboardEvent
/** @deprecated */
char: undefined;
/** @deprecated */
charCode: undefined;
key: undefined;
/** @deprecated */
keyCode: undefined;
// TouchEvent
changedTouches: undefined;
targetTouches: undefined;
touches: undefined;
// MouseEvent, KeyboardEvent
/**
* For key or mouse events, this property indicates the specific key or button that was pressed.
* @see \`{@link https://api.jquery.com/event.which/ }\`
* @since 1.1.3
* @deprecated Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`.
* @example ````Log which key was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="type something">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "keydown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
* @example ````Log which mouse button was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="click here">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "mousedown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
*/
which: undefined;
// MouseEvent, KeyboardEvent, TouchEvent
altKey: undefined;
ctrlKey: undefined;
/**
* Indicates whether the META key was pressed when the event fired.
* @see \`{@link https://api.jquery.com/event.metaKey/ }\`
* @since 1.0.4
* @example ````Determine whether the META key was pressed when the event fired.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.metaKey demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button value="Test" name="Test" id="checkMetaKey">Click me!</button>
<div id="display"></div>
<script>
$( "#checkMetaKey" ).click(function( event ) {
$( "#display" ).text( event.metaKey );
});
</script>
</body>
</html>
```
*/
metaKey: undefined;
shiftKey: undefined;
originalEvent?: _Event;
}
interface ChangeEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends EventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'change';
}
interface ResizeEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends EventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'resize';
}
interface ScrollEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends EventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'scroll';
}
interface SelectEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends EventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'select';
}
interface SubmitEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends EventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'submit';
}
// #endregion
// region UIEvent
// #region UIEvent
interface UIEventBase<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends TriggeredEvent<TDelegateTarget, TData, TCurrentTarget, TTarget> {
// Event
bubbles: boolean;
cancelable: boolean;
eventPhase: number;
// UIEvent
detail: number;
view: Window;
originalEvent?: _UIEvent;
}
// region MouseEvent
// #region MouseEvent
interface MouseEventBase<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends UIEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: EventTarget | null;
// MouseEvent
button: number;
buttons: number;
clientX: number;
clientY: number;
offsetX: number;
offsetY: number;
/**
* The mouse position relative to the left edge of the document.
* @see \`{@link https://api.jquery.com/event.pageX/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageX demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageX: number;
/**
* The mouse position relative to the top edge of the document.
* @see \`{@link https://api.jquery.com/event.pageY/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageY demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageY: number;
screenX: number;
screenY: number;
/** @deprecated */
toElement: Element;
// PointerEvent
pointerId: undefined;
pointerType: undefined;
// KeyboardEvent
/** @deprecated */
char: undefined;
/** @deprecated */
charCode: undefined;
key: undefined;
/** @deprecated */
keyCode: undefined;
// TouchEvent
changedTouches: undefined;
targetTouches: undefined;
touches: undefined;
// MouseEvent, KeyboardEvent
/**
* For key or mouse events, this property indicates the specific key or button that was pressed.
* @see \`{@link https://api.jquery.com/event.which/ }\`
* @since 1.1.3
* @deprecated Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`.
* @example ````Log which key was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="type something">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "keydown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
* @example ````Log which mouse button was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="click here">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "mousedown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
*/
which: number;
// MouseEvent, KeyboardEvent, TouchEvent
altKey: boolean;
ctrlKey: boolean;
/**
* Indicates whether the META key was pressed when the event fired.
* @see \`{@link https://api.jquery.com/event.metaKey/ }\`
* @since 1.0.4
* @example ````Determine whether the META key was pressed when the event fired.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.metaKey demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button value="Test" name="Test" id="checkMetaKey">Click me!</button>
<div id="display"></div>
<script>
$( "#checkMetaKey" ).click(function( event ) {
$( "#display" ).text( event.metaKey );
});
</script>
</body>
</html>
```
*/
metaKey: boolean;
shiftKey: boolean;
originalEvent?: _MouseEvent;
}
interface ClickEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: null;
type: 'click';
}
interface ContextMenuEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: null;
type: 'contextmenu';
}
interface DoubleClickEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: null;
type: 'dblclick';
}
interface MouseDownEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: null;
type: 'mousedown';
}
interface MouseEnterEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
// Special handling by jQuery.
type: 'mouseover';
}
interface MouseLeaveEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
// Special handling by jQuery.
type: 'mouseout';
}
interface MouseMoveEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: null;
type: 'mousemove';
}
interface MouseOutEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'mouseout';
}
interface MouseOverEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'mouseover';
}
interface MouseUpEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends MouseEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: null;
type: 'mouseup';
}
// region DragEvent
// #region DragEvent
interface DragEventBase<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends UIEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
originalEvent?: _DragEvent;
}
interface DragEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends DragEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'drag';
}
interface DragEndEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends DragEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'dragend';
}
interface DragEnterEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends DragEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'dragenter';
}
interface DragExitEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends DragEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'dragexit';
}
interface DragLeaveEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends DragEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'dragleave';
}
interface DragOverEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends DragEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'dragover';
}
interface DragStartEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends DragEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'dragstart';
}
interface DropEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends DragEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'drop';
}
// #endregion
// #endregion
// region KeyboardEvent
// #region KeyboardEvent
interface KeyboardEventBase<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends UIEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: undefined;
// MouseEvent
button: undefined;
buttons: undefined;
clientX: undefined;
clientY: undefined;
offsetX: undefined;
offsetY: undefined;
/**
* The mouse position relative to the left edge of the document.
* @see \`{@link https://api.jquery.com/event.pageX/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageX demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageX: undefined;
/**
* The mouse position relative to the top edge of the document.
* @see \`{@link https://api.jquery.com/event.pageY/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageY demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageY: undefined;
screenX: undefined;
screenY: undefined;
/** @deprecated */
toElement: undefined;
// PointerEvent
pointerId: undefined;
pointerType: undefined;
// KeyboardEvent
/** @deprecated */
char: string | undefined;
/** @deprecated */
charCode: number;
code: string;
key: string;
/** @deprecated */
keyCode: number;
// TouchEvent
changedTouches: undefined;
targetTouches: undefined;
touches: undefined;
// MouseEvent, KeyboardEvent
/**
* For key or mouse events, this property indicates the specific key or button that was pressed.
* @see \`{@link https://api.jquery.com/event.which/ }\`
* @since 1.1.3
* @deprecated Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`.
* @example ````Log which key was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="type something">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "keydown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
* @example ````Log which mouse button was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="click here">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "mousedown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
*/
which: number;
// MouseEvent, KeyboardEvent, TouchEvent
altKey: boolean;
ctrlKey: boolean;
/**
* Indicates whether the META key was pressed when the event fired.
* @see \`{@link https://api.jquery.com/event.metaKey/ }\`
* @since 1.0.4
* @example ````Determine whether the META key was pressed when the event fired.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.metaKey demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button value="Test" name="Test" id="checkMetaKey">Click me!</button>
<div id="display"></div>
<script>
$( "#checkMetaKey" ).click(function( event ) {
$( "#display" ).text( event.metaKey );
});
</script>
</body>
</html>
```
*/
metaKey: boolean;
shiftKey: boolean;
originalEvent?: _KeyboardEvent;
}
interface KeyDownEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends KeyboardEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'keydown';
}
interface KeyPressEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends KeyboardEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'keypress';
}
interface KeyUpEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends KeyboardEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'keyup';
}
// #endregion
// region TouchEvent
// #region TouchEvent
interface TouchEventBase<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends UIEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: undefined;
// MouseEvent
button: undefined;
buttons: undefined;
clientX: undefined;
clientY: undefined;
offsetX: undefined;
offsetY: undefined;
/**
* The mouse position relative to the left edge of the document.
* @see \`{@link https://api.jquery.com/event.pageX/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageX demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageX: undefined;
/**
* The mouse position relative to the top edge of the document.
* @see \`{@link https://api.jquery.com/event.pageY/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageY demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageY: undefined;
screenX: undefined;
screenY: undefined;
/** @deprecated */
toElement: undefined;
// PointerEvent
pointerId: undefined;
pointerType: undefined;
// KeyboardEvent
/** @deprecated */
char: undefined;
/** @deprecated */
charCode: undefined;
key: undefined;
/** @deprecated */
keyCode: undefined;
// TouchEvent
changedTouches: TouchList;
targetTouches: TouchList;
touches: TouchList;
// MouseEvent, KeyboardEvent
/**
* For key or mouse events, this property indicates the specific key or button that was pressed.
* @see \`{@link https://api.jquery.com/event.which/ }\`
* @since 1.1.3
* @deprecated Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`.
* @example ````Log which key was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="type something">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "keydown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
* @example ````Log which mouse button was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="click here">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "mousedown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
*/
which: undefined;
// MouseEvent, KeyboardEvent, TouchEvent
altKey: boolean;
ctrlKey: boolean;
/**
* Indicates whether the META key was pressed when the event fired.
* @see \`{@link https://api.jquery.com/event.metaKey/ }\`
* @since 1.0.4
* @example ````Determine whether the META key was pressed when the event fired.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.metaKey demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button value="Test" name="Test" id="checkMetaKey">Click me!</button>
<div id="display"></div>
<script>
$( "#checkMetaKey" ).click(function( event ) {
$( "#display" ).text( event.metaKey );
});
</script>
</body>
</html>
```
*/
metaKey: boolean;
shiftKey: boolean;
originalEvent?: _TouchEvent;
}
interface TouchCancelEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends TouchEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'touchcancel';
}
interface TouchEndEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends TouchEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'touchend';
}
interface TouchMoveEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends TouchEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'touchmove';
}
interface TouchStartEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends TouchEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'touchstart';
}
// #endregion
// region FocusEvent
// #region FocusEvent
interface FocusEventBase<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends UIEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
/**
* The other DOM element involved in the event, if any.
* @see \`{@link https://api.jquery.com/event.relatedTarget/ }\`
* @since 1.1.4
* @example ````On mouseout of anchors, alert the element type being entered.
```javascript
$( "a" ).mouseout(function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
});
```
*/
relatedTarget?: EventTarget | null;
// MouseEvent
button: undefined;
buttons: undefined;
clientX: undefined;
clientY: undefined;
offsetX: undefined;
offsetY: undefined;
/**
* The mouse position relative to the left edge of the document.
* @see \`{@link https://api.jquery.com/event.pageX/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageX demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageX: undefined;
/**
* The mouse position relative to the top edge of the document.
* @see \`{@link https://api.jquery.com/event.pageY/ }\`
* @since 1.0.4
* @example ````Show the mouse position relative to the left and top edges of the document (within this iframe).
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.pageY demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<div id="log"></div>
<script>
$( document ).on( "mousemove", function( event ) {
$( "#log" ).text( "pageX: " + event.pageX + ", pageY: " + event.pageY );
});
</script>
</body>
</html>
```
*/
pageY: undefined;
screenX: undefined;
screenY: undefined;
/** @deprecated */
toElement: undefined;
// PointerEvent
pointerId: undefined;
pointerType: undefined;
// KeyboardEvent
/** @deprecated */
char: undefined;
/** @deprecated */
charCode: undefined;
key: undefined;
/** @deprecated */
keyCode: undefined;
// TouchEvent
changedTouches: undefined;
targetTouches: undefined;
touches: undefined;
// MouseEvent, KeyboardEvent
/**
* For key or mouse events, this property indicates the specific key or button that was pressed.
* @see \`{@link https://api.jquery.com/event.which/ }\`
* @since 1.1.3
* @deprecated Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`.
* @example ````Log which key was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="type something">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "keydown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
* @example ````Log which mouse button was depressed.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.which demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<input id="whichkey" value="click here">
<div id="log"></div>
<script>
$( "#whichkey" ).on( "mousedown", function( event ) {
$( "#log" ).html( event.type + ": " + event.which );
});
</script>
</body>
</html>
```
*/
which: undefined;
// MouseEvent, KeyboardEvent, TouchEvent
altKey: undefined;
ctrlKey: undefined;
/**
* Indicates whether the META key was pressed when the event fired.
* @see \`{@link https://api.jquery.com/event.metaKey/ }\`
* @since 1.0.4
* @example ````Determine whether the META key was pressed when the event fired.
```html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>event.metaKey demo</title>
<style>
body {
background-color: #eef;
}
div {
padding: 20px;
}
</style>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>
<button value="Test" name="Test" id="checkMetaKey">Click me!</button>
<div id="display"></div>
<script>
$( "#checkMetaKey" ).click(function( event ) {
$( "#display" ).text( event.metaKey );
});
</script>
</body>
</html>
```
*/
metaKey: undefined;
shiftKey: undefined;
originalEvent?: _FocusEvent;
}
interface BlurEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends FocusEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'blur';
}
interface FocusEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends FocusEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'focus';
}
interface FocusInEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends FocusEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'focusin';
}
interface FocusOutEvent<
TDelegateTarget = any,
TData = any,
TCurrentTarget = any,
TTarget = any
> extends FocusEventBase<TDelegateTarget, TData, TCurrentTarget, TTarget> {
type: 'focusout';
}
// #endregion
// #endregion
interface TypeToTriggeredEventMap<
TDelegateTarget,
TData,
TCurrentTarget,
TTarget
> {
// Event
change: ChangeEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
resize: ResizeEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
scroll: ScrollEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
select: SelectEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
submit: SubmitEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
// UIEvent
// MouseEvent
click: ClickEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
contextmenu: ContextMenuEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
dblclick: DoubleClickEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
mousedown: MouseDownEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
mouseenter: MouseEnterEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
mouseleave: MouseLeaveEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
mousemove: MouseMoveEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
mouseout: MouseOutEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
mouseover: MouseOverEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
mouseup: MouseUpEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
// DragEvent
drag: DragEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
dragend: DragEndEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
dragenter: DragEnterEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
dragexit: DragExitEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
dragleave: DragLeaveEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
dragover: DragOverEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
dragstart: DragStartEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
drop: DropEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
// KeyboardEvent
keydown: KeyDownEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
keypress: KeyPressEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
keyup: KeyUpEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
// TouchEvent
touchcancel: TouchCancelEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
touchend: TouchEndEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
touchmove: TouchMoveEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
touchstart: TouchStartEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
// FocusEvent
blur: BlurEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
focus: FocusEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
focusin: FocusInEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
focusout: FocusOutEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
[type: string]: TriggeredEvent<TDelegateTarget, TData, TCurrentTarget, TTarget>;
}
// Extra parameters can be passed from trigger()
type EventHandlerBase<TContext, T> = (this: TContext, t: T, ...args: any[]) => any;
type EventHandler<
TCurrentTarget,
TData = undefined
> = EventHandlerBase<TCurrentTarget, TriggeredEvent<TCurrentTarget, TData>>;
type TypeEventHandler<
TDelegateTarget,
TData,
TCurrentTarget,
TTarget,
TType extends keyof TypeToTriggeredEventMap<TDelegateTarget, TData, TCurrentTarget, TTarget>
> = EventHandlerBase<TCurrentTarget, TypeToTriggeredEventMap<TDelegateTarget, TData, TCurrentTarget, TTarget>[TType]>;
interface TypeEventHandlers<
TDelegateTarget,
TData,
TCurrentTarget,
TTarget
> extends _TypeEventHandlers<TDelegateTarget, TData, TCurrentTarget, TTarget> {
// No idea why it's necessary to include `object` in the union but otherwise TypeScript complains that
// derived types of Event are not assignable to Event.
[type: string]: TypeEventHandler<TDelegateTarget, TData, TCurrentTarget, TTarget, string> |
false |
undefined |
object;
}
type _TypeEventHandlers<
TDelegateTarget,
TData,
TCurrentTarget,
TTarget
> = {
[TType in keyof TypeToTriggeredEventMap<TDelegateTarget, TData, TCurrentTarget, TTarget>]?:
TypeEventHandler<TDelegateTarget, TData, TCurrentTarget, TTarget, TType> |
false |
object;
};
// region Event extensions
// #region Event extensions
interface EventExtensions {
/**
* The jQuery special event hooks are a set of per-event-name functions and properties that allow code to control the behavior of event processing within jQuery. The mechanism is similar to `fixHooks` in that the special event information is stored in `jQuery.event.special.NAME`, where `NAME` is the name of the special event. Event names are case sensitive.
*
* As with `fixHooks`, the special event hooks design assumes it will be very rare that two unrelated pieces of code want to process the same event name. Special event authors who need to modify events with existing hooks will need to take precautions to avoid introducing unwanted side-effects by clobbering those hooks.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#special-event-hooks }\`
*/
special: SpecialEventHooks;
}
// region Special event hooks
// #region Special event hooks
/**
* The jQuery special event hooks are a set of per-event-name functions and properties that allow code to control the behavior of event processing within jQuery. The mechanism is similar to `fixHooks` in that the special event information is stored in `jQuery.event.special.NAME`, where `NAME` is the name of the special event. Event names are case sensitive.
*
* As with `fixHooks`, the special event hooks design assumes it will be very rare that two unrelated pieces of code want to process the same event name. Special event authors who need to modify events with existing hooks will need to take precautions to avoid introducing unwanted side-effects by clobbering those hooks.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#special-event-hooks }\`
*/
// Workaround for TypeScript 2.3 which does not have support for weak types handling.
type SpecialEventHook<TTarget, TData> = {
/**
* Indicates whether this event type should be bubbled when the `.trigger()` method is called; by default it is `false`, meaning that a triggered event will bubble to the element's parents up to the document (if attached to a document) and then to the window. Note that defining `noBubble` on an event will effectively prevent that event from being used for delegated events with `.trigger()`.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#nobubble-boolean }\`
*/
noBubble: boolean;
} | {
/**
* When defined, these string properties specify that a special event should be handled like another event type until the event is delivered. The `bindType` is used if the event is attached directly, and the `delegateType` is used for delegated events. These types are generally DOM event types, and _should not_ be a special event themselves.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#bindtype-string-delegatetype-string }\`
*/
bindType: string;
} | {
/**
* When defined, these string properties specify that a special event should be handled like another event type until the event is delivered. The `bindType` is used if the event is attached directly, and the `delegateType` is used for delegated events. These types are generally DOM event types, and _should not_ be a special event themselves.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#bindtype-string-delegatetype-string }\`
*/
delegateType: string;
} | {
/**
* The setup hook is called the first time an event of a particular type is attached to an element; this provides the hook an opportunity to do processing that will apply to all events of this type on this element. The `this` keyword will be a reference to the element where the event is being attached and `eventHandle` is jQuery's event handler function. In most cases the `namespaces` argument should not be used, since it only represents the namespaces of the _first_ event being attached; subsequent events may not have this same namespaces.
*
* This hook can perform whatever processing it desires, including attaching its own event handlers to the element or to other elements and recording setup information on the element using the `jQuery.data()` method. If the setup hook wants jQuery to add a browser event (via `addEventListener` or `attachEvent`, depending on browser) it should return `false`. In all other cases, jQuery will not add the browser event, but will continue all its other bookkeeping for the event. This would be appropriate, for example, if the event was never fired by the browser but invoked by `.trigger()`. To attach the jQuery event handler in the setup hook, use the `eventHandle` argument.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#setup-function-data-object-namespaces-eventhandle-function }\`
*/
setup(this: TTarget, data: TData, namespaces: string, eventHandle: EventHandler<TTarget, TData>): void | false;
} | {
/**
* The teardown hook is called when the final event of a particular type is removed from an element. The `this` keyword will be a reference to the element where the event is being cleaned up. This hook should return `false` if it wants jQuery to remove the event from the browser's event system (via `removeEventListener` or `detachEvent`). In most cases, the setup and teardown hooks should return the same value.
*
* If the setup hook attached event handlers or added data to an element through a mechanism such as `jQuery.data()`, the teardown hook should reverse the process and remove them. jQuery will generally remove the data and events when an element is totally removed from the document, but failing to remove data or events on teardown will cause a memory leak if the element stays in the document.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#teardown-function }\`
*/
teardown(this: TTarget): void | false;
} | {
/**
* Each time an event handler is added to an element through an API such as `.on()`, jQuery calls this hook. The `this` keyword will be the element to which the event handler is being added, and the `handleObj` argument is as described in the section above. The return value of this hook is ignored.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#add-function-handleobj }\`
*/
add(this: TTarget, handleObj: HandleObject<TTarget, TData>): void;
} | {
/**
* When an event handler is removed from an element using an API such as `.off()`, this hook is called. The `this` keyword will be the element where the handler is being removed, and the `handleObj` argument is as described in the section above. The return value of this hook is ignored.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#remove-function-handleobj }\`
*/
remove(this: TTarget, handleObj: HandleObject<TTarget, TData>): void;
} | {
/**
* Called when the `.trigger()` or `.triggerHandler()` methods are used to trigger an event for the special type from code, as opposed to events that originate from within the browser. The `this` keyword will be the element being triggered, and the event argument will be a `jQuery.Event` object constructed from the caller's input. At minimum, the event type, data, namespace, and target properties are set on the event. The data argument represents additional data passed by `.trigger()` if present.
*
* The trigger hook is called early in the process of triggering an event, just after the `jQuery.Event` object is constructed and before any handlers have been called. It can process the triggered event in any way, for example by calling `event.stopPropagation()` or `event.preventDefault()` before returning. If the hook returns `false`, jQuery does not perform any further event triggering actions and returns immediately. Otherwise, it performs the normal trigger processing, calling any event handlers for the element and bubbling the event (unless propagation is stopped in advance or `noBubble` was specified for the special event) to call event handlers attached to parent elements.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#trigger-function-event-jquery-event-data-object }\`
*/
trigger(this: TTarget, event: Event, data: TData): void | false;
} | {
/**
* When the `.trigger()` method finishes running all the event handlers for an event, it also looks for and runs any method on the target object by the same name unless of the handlers called `event.preventDefault()`. So, `.trigger( "submit" )` will execute the `submit()` method on the element if one exists. When a `_default` hook is specified, the hook is called just prior to checking for and executing the element's default method. If this hook returns the value `false` the element's default method will be called; otherwise it is not.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#_default-function-event-jquery-event-data-object }\`
*/
_default(event: TriggeredEvent<TTarget, TData>, data: TData): void | false;
} | {
/**
* jQuery calls a handle hook when the event has occurred and jQuery would normally call the user's event handler specified by `.on()` or another event binding method. If the hook exists, jQuery calls it _instead_ of that event handler, passing it the event and any data passed from `.trigger()` if it was not a native event. The `this` keyword is the DOM element being handled, and `event.handleObj` property has the detailed event information.
*
* Based in the information it has, the handle hook should decide whether to call the original handler function which is in `event.handleObj.handler`. It can modify information in the event object before calling the original handler, but _must restore_ that data before returning or subsequent unrelated event handlers may act unpredictably. In most cases, the handle hook should return the result of the original handler, but that is at the discretion of the hook. The handle hook is unique in that it is the only special event function hook that is called under its original special event name when the type is mapped using `bindType` and `delegateType`. For that reason, it is almost always an error to have anything other than a handle hook present if the special event defines a `bindType` and `delegateType`, since those other hooks will never be called.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#handle-function-event-jquery-event-data-object }\`
*/
handle(this: TTarget, event: TriggeredEvent<TTarget, TData> & { handleObj: HandleObject<TTarget, TData>; }, ...data: TData[]): void;
} | {
preDispatch(this: TTarget, event: Event): false | void;
} | {
postDispatch(this: TTarget, event: Event): void;
} | {
[key: string]: never;
};
interface SpecialEventHooks {
[event: string]: SpecialEventHook<EventTarget, any>;
}
/**
* Many of the special event hook functions below are passed a `handleObj` object that provides more information about the event, how it was attached, and its current state. This object and its contents should be treated as read-only data, and only the properties below are documented for use by special event handlers.
* @see \`{@link https://learn.jquery.com/events/event-extensions/#the-handleobj-object }\`
*/
interface HandleObject<TTarget, TData> {
/**
* The type of event, such as `"click"`. When special event mapping is used via `bindType` or `delegateType`, this will be the mapped type.
*/
readonly type: string;
/**
* The original type name regardless of whether it was mapped via `bindType` or `delegateType`. So when a "pushy" event is mapped to "click" its `origType` would be "pushy".
*/
readonly origType: string;
/**
* Namespace(s), if any, provided when the event was attached, such as `"myPlugin"`. When multiple namespaces are given, they are separated by periods and sorted in ascending alphabetical order. If no namespaces are provided, this property is an empty string.
*/
readonly namespace: string;
/**
* For delegated events, this is the selector used to filter descendant elements and determine if the handler should be called. For directly bound events, this property is `null`.
*/
readonly selector: string | undefined | null;
/**
* The data, if any, passed to jQuery during event binding, e.g. `{ myData: 42 }`. If the data argument was omitted or `undefined`, this property is `undefined` as well.
*/
readonly data: TData;
/**
* Event handler function passed to jQuery during event binding. If `false` was passed during event binding, the handler refers to a single shared function that simply returns `false`.
*/
readonly handler: EventHandler<TTarget, TData>;
}
// #endregion
// #endregion
// #endregion
interface NameValuePair {
name: string;
value: string;
}
// region Coordinates
// #region Coordinates
interface Coordinates {
left: number;
top: number;
}
// Workaround for TypeScript 2.3 which does not have support for weak types handling.
type CoordinatesPartial =
Pick<Coordinates, 'left'> |
Pick<Coordinates, 'top'> |
{ [key: string]: never; };
// #endregion
// region Val hooks
// #region Val hooks
// Workaround for TypeScript 2.3 which does not have support for weak types handling.
type ValHook<TElement> = {
get(elem: TElement): any;
} | {
set(elem: TElement, value: any): any;
} | {
[key: string]: never;
};
interface ValHooks {
// Set to HTMLElement to minimize breaks but should probably be Element.
[nodeName: string]: ValHook<HTMLElement>;
}
// #endregion
type _Falsy = false | null | undefined | 0 | '' | typeof document.all;
}
declare const jQuery: JQueryStatic;
declare const $: JQueryStatic;
type _Event = Event;
type _UIEvent = UIEvent;
type _MouseEvent = MouseEvent;
type _DragEvent = DragEvent;
type _KeyboardEvent = KeyboardEvent;
type _TouchEvent = TouchEvent;
type _FocusEvent = FocusEvent;
// region ES5 compatibility
// #region ES5 compatibility
// Forward declaration of `Iterable<T>`.
// tslint:disable-next-line:no-empty-interface
interface Iterable<T> { }
interface SymbolConstructor {
/**
* A String value that is used in the creation of the default string description of an object.
* Called by the built-in method Object.prototype.toString.
*/
readonly toStringTag: symbol;
}
declare var Symbol: SymbolConstructor;
// #endregion
|