cdk8s 2.4.13 → 2.4.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/python.md CHANGED
@@ -930,7 +930,7 @@ This namespace will only apply to objects that don't have a
930
930
  Options to configure a cron expression.
931
931
 
932
932
  All fields are strings so you can use complex expressions. Absence of
933
- a field implies '*' or '?', whichever one is appropriate.
933
+ a field implies '*'
934
934
 
935
935
  #### Initializer <a name="[object Object].Initializer"></a>
936
936
 
@@ -942,8 +942,7 @@ cdk8s.CronOptions(
942
942
  hour: str = None,
943
943
  minute: str = None,
944
944
  month: str = None,
945
- week_day: str = None,
946
- year: str = None
945
+ week_day: str = None
947
946
  )
948
947
  ```
949
948
 
@@ -1012,19 +1011,6 @@ The day of the week to run this rule at.
1012
1011
 
1013
1012
  ---
1014
1013
 
1015
- ##### `year`<sup>Optional</sup> <a name="cdk8s.CronOptions.property.year"></a>
1016
-
1017
- ```python
1018
- year: str
1019
- ```
1020
-
1021
- - *Type:* `str`
1022
- - *Default:* Every year
1023
-
1024
- The year to run this rule at.
1025
-
1026
- ---
1027
-
1028
1014
  ### GroupVersionKind <a name="cdk8s.GroupVersionKind"></a>
1029
1015
 
1030
1016
  #### Initializer <a name="[object Object].Initializer"></a>
@@ -1753,6 +1739,194 @@ The object's namespace.
1753
1739
  ---
1754
1740
 
1755
1741
 
1742
+ ### Cron <a name="cdk8s.Cron"></a>
1743
+
1744
+ Represents a cron schedule.
1745
+
1746
+ #### Initializers <a name="cdk8s.Cron.Initializer"></a>
1747
+
1748
+ ```python
1749
+ import cdk8s
1750
+
1751
+ cdk8s.Cron(
1752
+ day: str = None,
1753
+ hour: str = None,
1754
+ minute: str = None,
1755
+ month: str = None,
1756
+ week_day: str = None
1757
+ )
1758
+ ```
1759
+
1760
+ ##### `day`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.day"></a>
1761
+
1762
+ - *Type:* `str`
1763
+ - *Default:* Every day of the month
1764
+
1765
+ The day of the month to run this rule at.
1766
+
1767
+ ---
1768
+
1769
+ ##### `hour`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.hour"></a>
1770
+
1771
+ - *Type:* `str`
1772
+ - *Default:* Every hour
1773
+
1774
+ The hour to run this rule at.
1775
+
1776
+ ---
1777
+
1778
+ ##### `minute`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.minute"></a>
1779
+
1780
+ - *Type:* `str`
1781
+ - *Default:* Every minute
1782
+
1783
+ The minute to run this rule at.
1784
+
1785
+ ---
1786
+
1787
+ ##### `month`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.month"></a>
1788
+
1789
+ - *Type:* `str`
1790
+ - *Default:* Every month
1791
+
1792
+ The month to run this rule at.
1793
+
1794
+ ---
1795
+
1796
+ ##### `week_day`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.week_day"></a>
1797
+
1798
+ - *Type:* `str`
1799
+ - *Default:* Any day of the week
1800
+
1801
+ The day of the week to run this rule at.
1802
+
1803
+ ---
1804
+
1805
+
1806
+ #### Static Functions <a name="Static Functions"></a>
1807
+
1808
+ ##### `annually` <a name="cdk8s.Cron.annually"></a>
1809
+
1810
+ ```python
1811
+ import cdk8s
1812
+
1813
+ cdk8s.Cron.annually()
1814
+ ```
1815
+
1816
+ ##### `daily` <a name="cdk8s.Cron.daily"></a>
1817
+
1818
+ ```python
1819
+ import cdk8s
1820
+
1821
+ cdk8s.Cron.daily()
1822
+ ```
1823
+
1824
+ ##### `every_minute` <a name="cdk8s.Cron.every_minute"></a>
1825
+
1826
+ ```python
1827
+ import cdk8s
1828
+
1829
+ cdk8s.Cron.every_minute()
1830
+ ```
1831
+
1832
+ ##### `hourly` <a name="cdk8s.Cron.hourly"></a>
1833
+
1834
+ ```python
1835
+ import cdk8s
1836
+
1837
+ cdk8s.Cron.hourly()
1838
+ ```
1839
+
1840
+ ##### `monthly` <a name="cdk8s.Cron.monthly"></a>
1841
+
1842
+ ```python
1843
+ import cdk8s
1844
+
1845
+ cdk8s.Cron.monthly()
1846
+ ```
1847
+
1848
+ ##### `schedule` <a name="cdk8s.Cron.schedule"></a>
1849
+
1850
+ ```python
1851
+ import cdk8s
1852
+
1853
+ cdk8s.Cron.schedule(
1854
+ day: str = None,
1855
+ hour: str = None,
1856
+ minute: str = None,
1857
+ month: str = None,
1858
+ week_day: str = None
1859
+ )
1860
+ ```
1861
+
1862
+ ###### `day`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.day"></a>
1863
+
1864
+ - *Type:* `str`
1865
+ - *Default:* Every day of the month
1866
+
1867
+ The day of the month to run this rule at.
1868
+
1869
+ ---
1870
+
1871
+ ###### `hour`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.hour"></a>
1872
+
1873
+ - *Type:* `str`
1874
+ - *Default:* Every hour
1875
+
1876
+ The hour to run this rule at.
1877
+
1878
+ ---
1879
+
1880
+ ###### `minute`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.minute"></a>
1881
+
1882
+ - *Type:* `str`
1883
+ - *Default:* Every minute
1884
+
1885
+ The minute to run this rule at.
1886
+
1887
+ ---
1888
+
1889
+ ###### `month`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.month"></a>
1890
+
1891
+ - *Type:* `str`
1892
+ - *Default:* Every month
1893
+
1894
+ The month to run this rule at.
1895
+
1896
+ ---
1897
+
1898
+ ###### `week_day`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.week_day"></a>
1899
+
1900
+ - *Type:* `str`
1901
+ - *Default:* Any day of the week
1902
+
1903
+ The day of the week to run this rule at.
1904
+
1905
+ ---
1906
+
1907
+ ##### `weekly` <a name="cdk8s.Cron.weekly"></a>
1908
+
1909
+ ```python
1910
+ import cdk8s
1911
+
1912
+ cdk8s.Cron.weekly()
1913
+ ```
1914
+
1915
+ #### Properties <a name="Properties"></a>
1916
+
1917
+ ##### `expression_string`<sup>Required</sup> <a name="cdk8s.Cron.property.expression_string"></a>
1918
+
1919
+ ```python
1920
+ expression_string: str
1921
+ ```
1922
+
1923
+ - *Type:* `str`
1924
+
1925
+ Retrieve the expression for this schedule.
1926
+
1927
+ ---
1928
+
1929
+
1756
1930
  ### DependencyGraph <a name="cdk8s.DependencyGraph"></a>
1757
1931
 
1758
1932
  Represents the dependency graph for a given Node.
@@ -2449,143 +2623,6 @@ Maximum allowed length for the name.
2449
2623
 
2450
2624
 
2451
2625
 
2452
- ### Schedule <a name="cdk8s.Schedule"></a>
2453
-
2454
- Represents a schedule.
2455
-
2456
- Note that rates cannot be defined in fractions of minutes.
2457
-
2458
- #### Initializers <a name="cdk8s.Schedule.Initializer"></a>
2459
-
2460
- ```python
2461
- import cdk8s
2462
-
2463
- cdk8s.Schedule()
2464
- ```
2465
-
2466
-
2467
- #### Static Functions <a name="Static Functions"></a>
2468
-
2469
- ##### `cron` <a name="cdk8s.Schedule.cron"></a>
2470
-
2471
- ```python
2472
- import cdk8s
2473
-
2474
- cdk8s.Schedule.cron(
2475
- day: str = None,
2476
- hour: str = None,
2477
- minute: str = None,
2478
- month: str = None,
2479
- week_day: str = None,
2480
- year: str = None
2481
- )
2482
- ```
2483
-
2484
- ###### `day`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.day"></a>
2485
-
2486
- - *Type:* `str`
2487
- - *Default:* Every day of the month
2488
-
2489
- The day of the month to run this rule at.
2490
-
2491
- ---
2492
-
2493
- ###### `hour`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.hour"></a>
2494
-
2495
- - *Type:* `str`
2496
- - *Default:* Every hour
2497
-
2498
- The hour to run this rule at.
2499
-
2500
- ---
2501
-
2502
- ###### `minute`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.minute"></a>
2503
-
2504
- - *Type:* `str`
2505
- - *Default:* Every minute
2506
-
2507
- The minute to run this rule at.
2508
-
2509
- ---
2510
-
2511
- ###### `month`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.month"></a>
2512
-
2513
- - *Type:* `str`
2514
- - *Default:* Every month
2515
-
2516
- The month to run this rule at.
2517
-
2518
- ---
2519
-
2520
- ###### `week_day`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.week_day"></a>
2521
-
2522
- - *Type:* `str`
2523
- - *Default:* Any day of the week
2524
-
2525
- The day of the week to run this rule at.
2526
-
2527
- ---
2528
-
2529
- ###### `year`<sup>Optional</sup> <a name="cdk8s.CronOptions.parameter.year"></a>
2530
-
2531
- - *Type:* `str`
2532
- - *Default:* Every year
2533
-
2534
- The year to run this rule at.
2535
-
2536
- ---
2537
-
2538
- ##### `expression` <a name="cdk8s.Schedule.expression"></a>
2539
-
2540
- ```python
2541
- import cdk8s
2542
-
2543
- cdk8s.Schedule.expression(
2544
- expression: str
2545
- )
2546
- ```
2547
-
2548
- ###### `expression`<sup>Required</sup> <a name="cdk8s.Schedule.parameter.expression"></a>
2549
-
2550
- - *Type:* `str`
2551
-
2552
- The expression to use.
2553
-
2554
- Must be in a format of 'value unit'
2555
-
2556
- ---
2557
-
2558
- ##### `rate` <a name="cdk8s.Schedule.rate"></a>
2559
-
2560
- ```python
2561
- import cdk8s
2562
-
2563
- cdk8s.Schedule.rate(
2564
- duration: Duration
2565
- )
2566
- ```
2567
-
2568
- ###### `duration`<sup>Required</sup> <a name="cdk8s.Schedule.parameter.duration"></a>
2569
-
2570
- - *Type:* [`cdk8s.Duration`](#cdk8s.Duration)
2571
-
2572
- ---
2573
-
2574
- #### Properties <a name="Properties"></a>
2575
-
2576
- ##### `expression_string`<sup>Required</sup> <a name="cdk8s.Schedule.property.expression_string"></a>
2577
-
2578
- ```python
2579
- expression_string: str
2580
- ```
2581
-
2582
- - *Type:* `str`
2583
-
2584
- Retrieve the expression for this schedule.
2585
-
2586
- ---
2587
-
2588
-
2589
2626
  ### Size <a name="cdk8s.Size"></a>
2590
2627
 
2591
2628
  Represents the amount of digital storage.
@@ -774,7 +774,7 @@ This namespace will only apply to objects that don't have a
774
774
  Options to configure a cron expression.
775
775
 
776
776
  All fields are strings so you can use complex expressions. Absence of
777
- a field implies '*' or '?', whichever one is appropriate.
777
+ a field implies '*'
778
778
 
779
779
  #### Initializer <a name="[object Object].Initializer"></a>
780
780
 
@@ -849,19 +849,6 @@ The day of the week to run this rule at.
849
849
 
850
850
  ---
851
851
 
852
- ##### `year`<sup>Optional</sup> <a name="cdk8s.CronOptions.property.year"></a>
853
-
854
- ```typescript
855
- public readonly year: string;
856
- ```
857
-
858
- - *Type:* `string`
859
- - *Default:* Every year
860
-
861
- The year to run this rule at.
862
-
863
- ---
864
-
865
852
  ### GroupVersionKind <a name="cdk8s.GroupVersionKind"></a>
866
853
 
867
854
  #### Initializer <a name="[object Object].Initializer"></a>
@@ -1380,6 +1367,104 @@ The object's namespace.
1380
1367
  ---
1381
1368
 
1382
1369
 
1370
+ ### Cron <a name="cdk8s.Cron"></a>
1371
+
1372
+ Represents a cron schedule.
1373
+
1374
+ #### Initializers <a name="cdk8s.Cron.Initializer"></a>
1375
+
1376
+ ```typescript
1377
+ import { Cron } from 'cdk8s'
1378
+
1379
+ new Cron(cronOptions?: CronOptions)
1380
+ ```
1381
+
1382
+ ##### `cronOptions`<sup>Optional</sup> <a name="cdk8s.Cron.parameter.cronOptions"></a>
1383
+
1384
+ - *Type:* [`cdk8s.CronOptions`](#cdk8s.CronOptions)
1385
+
1386
+ ---
1387
+
1388
+
1389
+ #### Static Functions <a name="Static Functions"></a>
1390
+
1391
+ ##### `annually` <a name="cdk8s.Cron.annually"></a>
1392
+
1393
+ ```typescript
1394
+ import { Cron } from 'cdk8s'
1395
+
1396
+ Cron.annually()
1397
+ ```
1398
+
1399
+ ##### `daily` <a name="cdk8s.Cron.daily"></a>
1400
+
1401
+ ```typescript
1402
+ import { Cron } from 'cdk8s'
1403
+
1404
+ Cron.daily()
1405
+ ```
1406
+
1407
+ ##### `everyMinute` <a name="cdk8s.Cron.everyMinute"></a>
1408
+
1409
+ ```typescript
1410
+ import { Cron } from 'cdk8s'
1411
+
1412
+ Cron.everyMinute()
1413
+ ```
1414
+
1415
+ ##### `hourly` <a name="cdk8s.Cron.hourly"></a>
1416
+
1417
+ ```typescript
1418
+ import { Cron } from 'cdk8s'
1419
+
1420
+ Cron.hourly()
1421
+ ```
1422
+
1423
+ ##### `monthly` <a name="cdk8s.Cron.monthly"></a>
1424
+
1425
+ ```typescript
1426
+ import { Cron } from 'cdk8s'
1427
+
1428
+ Cron.monthly()
1429
+ ```
1430
+
1431
+ ##### `schedule` <a name="cdk8s.Cron.schedule"></a>
1432
+
1433
+ ```typescript
1434
+ import { Cron } from 'cdk8s'
1435
+
1436
+ Cron.schedule(options: CronOptions)
1437
+ ```
1438
+
1439
+ ###### `options`<sup>Required</sup> <a name="cdk8s.Cron.parameter.options"></a>
1440
+
1441
+ - *Type:* [`cdk8s.CronOptions`](#cdk8s.CronOptions)
1442
+
1443
+ ---
1444
+
1445
+ ##### `weekly` <a name="cdk8s.Cron.weekly"></a>
1446
+
1447
+ ```typescript
1448
+ import { Cron } from 'cdk8s'
1449
+
1450
+ Cron.weekly()
1451
+ ```
1452
+
1453
+ #### Properties <a name="Properties"></a>
1454
+
1455
+ ##### `expressionString`<sup>Required</sup> <a name="cdk8s.Cron.property.expressionString"></a>
1456
+
1457
+ ```typescript
1458
+ public readonly expressionString: string;
1459
+ ```
1460
+
1461
+ - *Type:* `string`
1462
+
1463
+ Retrieve the expression for this schedule.
1464
+
1465
+ ---
1466
+
1467
+
1383
1468
  ### DependencyGraph <a name="cdk8s.DependencyGraph"></a>
1384
1469
 
1385
1470
  Represents the dependency graph for a given Node.
@@ -1943,84 +2028,6 @@ Name options.
1943
2028
 
1944
2029
 
1945
2030
 
1946
- ### Schedule <a name="cdk8s.Schedule"></a>
1947
-
1948
- Represents a schedule.
1949
-
1950
- Note that rates cannot be defined in fractions of minutes.
1951
-
1952
- #### Initializers <a name="cdk8s.Schedule.Initializer"></a>
1953
-
1954
- ```typescript
1955
- import { Schedule } from 'cdk8s'
1956
-
1957
- new Schedule()
1958
- ```
1959
-
1960
-
1961
- #### Static Functions <a name="Static Functions"></a>
1962
-
1963
- ##### `cron` <a name="cdk8s.Schedule.cron"></a>
1964
-
1965
- ```typescript
1966
- import { Schedule } from 'cdk8s'
1967
-
1968
- Schedule.cron(options: CronOptions)
1969
- ```
1970
-
1971
- ###### `options`<sup>Required</sup> <a name="cdk8s.Schedule.parameter.options"></a>
1972
-
1973
- - *Type:* [`cdk8s.CronOptions`](#cdk8s.CronOptions)
1974
-
1975
- ---
1976
-
1977
- ##### `expression` <a name="cdk8s.Schedule.expression"></a>
1978
-
1979
- ```typescript
1980
- import { Schedule } from 'cdk8s'
1981
-
1982
- Schedule.expression(expression: string)
1983
- ```
1984
-
1985
- ###### `expression`<sup>Required</sup> <a name="cdk8s.Schedule.parameter.expression"></a>
1986
-
1987
- - *Type:* `string`
1988
-
1989
- The expression to use.
1990
-
1991
- Must be in a format of 'value unit'
1992
-
1993
- ---
1994
-
1995
- ##### `rate` <a name="cdk8s.Schedule.rate"></a>
1996
-
1997
- ```typescript
1998
- import { Schedule } from 'cdk8s'
1999
-
2000
- Schedule.rate(duration: Duration)
2001
- ```
2002
-
2003
- ###### `duration`<sup>Required</sup> <a name="cdk8s.Schedule.parameter.duration"></a>
2004
-
2005
- - *Type:* [`cdk8s.Duration`](#cdk8s.Duration)
2006
-
2007
- ---
2008
-
2009
- #### Properties <a name="Properties"></a>
2010
-
2011
- ##### `expressionString`<sup>Required</sup> <a name="cdk8s.Schedule.property.expressionString"></a>
2012
-
2013
- ```typescript
2014
- public readonly expressionString: string;
2015
- ```
2016
-
2017
- - *Type:* `string`
2018
-
2019
- Retrieve the expression for this schedule.
2020
-
2021
- ---
2022
-
2023
-
2024
2031
  ### Size <a name="cdk8s.Size"></a>
2025
2032
 
2026
2033
  Represents the amount of digital storage.
package/lib/api-object.js CHANGED
@@ -106,7 +106,7 @@ class ApiObject extends constructs_1.Construct {
106
106
  }
107
107
  exports.ApiObject = ApiObject;
108
108
  _a = JSII_RTTI_SYMBOL_1;
109
- ApiObject[_a] = { fqn: "cdk8s.ApiObject", version: "2.4.13" };
109
+ ApiObject[_a] = { fqn: "cdk8s.ApiObject", version: "2.4.16" };
110
110
  function parseApiGroup(apiVersion) {
111
111
  const v = apiVersion.split('/');
112
112
  // no group means "core"
package/lib/app.js CHANGED
@@ -159,7 +159,7 @@ class App extends constructs_1.Construct {
159
159
  }
160
160
  exports.App = App;
161
161
  _a = JSII_RTTI_SYMBOL_1;
162
- App[_a] = { fqn: "cdk8s.App", version: "2.4.13" };
162
+ App[_a] = { fqn: "cdk8s.App", version: "2.4.16" };
163
163
  function validate(app) {
164
164
  const errors = [];
165
165
  for (const child of app.node.findAll()) {
package/lib/chart.js CHANGED
@@ -86,5 +86,5 @@ class Chart extends constructs_1.Construct {
86
86
  }
87
87
  exports.Chart = Chart;
88
88
  _a = JSII_RTTI_SYMBOL_1;
89
- Chart[_a] = { fqn: "cdk8s.Chart", version: "2.4.13" };
89
+ Chart[_a] = { fqn: "cdk8s.Chart", version: "2.4.16" };
90
90
  //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hhcnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvY2hhcnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSwyQ0FBeUQ7QUFFekQsK0JBQTRCO0FBQzVCLG1DQUFnQztBQUVoQyxNQUFNLFlBQVksR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLGFBQWEsQ0FBQyxDQUFDO0FBb0IvQyxNQUFhLEtBQU0sU0FBUSxzQkFBUztJQXFDbEMsWUFBWSxLQUFnQixFQUFFLEVBQVUsRUFBRSxRQUFvQixFQUFHO1FBQy9ELEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFDakIsSUFBSSxDQUFDLFNBQVMsR0FBRyxLQUFLLENBQUMsU0FBUyxDQUFDO1FBQ2pDLElBQUksQ0FBQyxPQUFPLEdBQUcsS0FBSyxDQUFDLE1BQU0sSUFBSSxFQUFFLENBQUM7UUFFbEMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxJQUFJLEVBQUUsWUFBWSxFQUFFLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7SUFDN0QsQ0FBQztJQTFDRDs7OztPQUlHO0lBQ0ksTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFNO1FBQzFCLE9BQU8sQ0FBQyxLQUFLLElBQUksSUFBSSxPQUFNLENBQUMsQ0FBQyxDQUFDLEtBQUssUUFBUSxJQUFJLFlBQVksSUFBSSxDQUFDLENBQUM7SUFDbkUsQ0FBQztJQUVEOzs7T0FHRztJQUNJLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBYTtRQUM1QixJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLEVBQUU7WUFDcEIsT0FBTyxDQUFDLENBQUM7U0FDVjtRQUVELE1BQU0sTUFBTSxHQUFHLGlCQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQWtCLENBQUM7UUFDN0MsSUFBSSxDQUFDLE1BQU0sRUFBRTtZQUNYLE1BQU0sSUFBSSxLQUFLLENBQUMscURBQXFELENBQUMsQ0FBQztTQUN4RTtRQUVELE9BQU8sS0FBSyxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUMxQixDQUFDO0lBb0JEOzs7O09BSUc7SUFDSCxJQUFXLE1BQU07UUFDZixPQUFPLEVBQUUsR0FBRyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7SUFDN0IsQ0FBQztJQUVEOzs7Ozs7Ozs7Ozs7Ozs7Ozs7O09BbUJHO0lBQ0ksa0JBQWtCLENBQUMsU0FBb0I7UUFDNUMsT0FBTyxhQUFLLENBQUMsVUFBVSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ3JDLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNJLGFBQWEsQ0FBQyxHQUFHLFlBQTBCO1FBQ2hELGlCQUFJLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxDQUFDLGFBQWEsQ0FBQyxHQUFHLFlBQVksQ0FBQyxDQUFDO0lBQy9DLENBQUM7SUFFRDs7O09BR0c7SUFDSSxNQUFNO1FBQ1gsT0FBTyxTQUFHLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQy9CLENBQUM7O0FBOUZILHNCQStGQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbnN0cnVjdCwgTm9kZSwgSUNvbnN0cnVjdCB9IGZyb20gJ2NvbnN0cnVjdHMnO1xuaW1wb3J0IHsgQXBpT2JqZWN0IH0gZnJvbSAnLi9hcGktb2JqZWN0JztcbmltcG9ydCB7IEFwcCB9IGZyb20gJy4vYXBwJztcbmltcG9ydCB7IE5hbWVzIH0gZnJvbSAnLi9uYW1lcyc7XG5cbmNvbnN0IENIQVJUX1NZTUJPTCA9IFN5bWJvbC5mb3IoJ2NkazhzLkNoYXJ0Jyk7XG5cbmV4cG9ydCBpbnRlcmZhY2UgQ2hhcnRQcm9wcyB7XG4gIC8qKlxuICAgKiBUaGUgZGVmYXVsdCBuYW1lc3BhY2UgZm9yIGFsbCBvYmplY3RzIGRlZmluZWQgaW4gdGhpcyBjaGFydCAoZGlyZWN0bHkgb3JcbiAgICogaW5kaXJlY3RseSkuIFRoaXMgbmFtZXNwYWNlIHdpbGwgb25seSBhcHBseSB0byBvYmplY3RzIHRoYXQgZG9uJ3QgaGF2ZSBhXG4gICAqIGBuYW1lc3BhY2VgIGV4cGxpY2l0bHkgZGVmaW5lZCBmb3IgdGhlbS5cbiAgICpcbiAgICogQGRlZmF1bHQgLSBubyBuYW1lc3BhY2UgaXMgc3ludGhlc2l6ZWQgKHVzdWFsbHkgdGhpcyBpbXBsaWVzIFwiZGVmYXVsdFwiKVxuICAgKi9cbiAgcmVhZG9ubHkgbmFtZXNwYWNlPzogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBMYWJlbHMgdG8gYXBwbHkgdG8gYWxsIHJlc291cmNlcyBpbiB0aGlzIGNoYXJ0LlxuICAgKlxuICAgKiBAZGVmYXVsdCAtIG5vIGNvbW1vbiBsYWJlbHNcbiAgICovXG4gIHJlYWRvbmx5IGxhYmVscz86IHsgW25hbWU6IHN0cmluZ106IHN0cmluZyB9O1xufVxuXG5leHBvcnQgY2xhc3MgQ2hhcnQgZXh0ZW5kcyBDb25zdHJ1Y3Qge1xuICAvKipcbiAgICogUmV0dXJuIHdoZXRoZXIgdGhlIGdpdmVuIG9iamVjdCBpcyBhIENoYXJ0LlxuICAgKlxuICAgKiBXZSBkbyBhdHRyaWJ1dGUgZGV0ZWN0aW9uIHNpbmNlIHdlIGNhbid0IHJlbGlhYmx5IHVzZSAnaW5zdGFuY2VvZicuXG4gICAqL1xuICBwdWJsaWMgc3RhdGljIGlzQ2hhcnQoeDogYW55KTogeCBpcyBDaGFydCB7XG4gICAgcmV0dXJuIHggIT09IG51bGwgJiYgdHlwZW9mKHgpID09PSAnb2JqZWN0JyAmJiBDSEFSVF9TWU1CT0wgaW4geDtcbiAgfVxuXG4gIC8qKlxuICAgKiBGaW5kcyB0aGUgY2hhcnQgaW4gd2hpY2ggYSBub2RlIGlzIGRlZmluZWQuXG4gICAqIEBwYXJhbSBjIGEgY29uc3RydWN0IG5vZGVcbiAgICovXG4gIHB1YmxpYyBzdGF0aWMgb2YoYzogSUNvbnN0cnVjdCk6IENoYXJ0IHtcbiAgICBpZiAoQ2hhcnQuaXNDaGFydChjKSkge1xuICAgICAgcmV0dXJuIGM7XG4gICAgfVxuXG4gICAgY29uc3QgcGFyZW50ID0gTm9kZS5vZihjKS5zY29wZSBhcyBDb25zdHJ1Y3Q7XG4gICAgaWYgKCFwYXJlbnQpIHtcbiAgICAgIHRocm93IG5ldyBFcnJvcignY2Fubm90IGZpbmQgYSBwYXJlbnQgY2hhcnQgKGRpcmVjdGx5IG9yIGluZGlyZWN0bHkpJyk7XG4gICAgfVxuXG4gICAgcmV0dXJuIENoYXJ0Lm9mKHBhcmVudCk7XG4gIH1cblxuICAvKipcbiAgICogVGhlIGRlZmF1bHQgbmFtZXNwYWNlIGZvciBhbGwgb2JqZWN0cyBpbiB0aGlzIGNoYXJ0LlxuICAgKi9cbiAgcHVibGljIHJlYWRvbmx5IG5hbWVzcGFjZT86IHN0cmluZztcblxuICAvKipcbiAgICogQ2hhcnQtbGV2ZWwgbGFiZWxzLlxuICAgKi9cbiAgcHJpdmF0ZSByZWFkb25seSBfbGFiZWxzPzogeyBbbmFtZTogc3RyaW5nXTogc3RyaW5nIH07XG5cbiAgY29uc3RydWN0b3Ioc2NvcGU6IENvbnN0cnVjdCwgaWQ6IHN0cmluZywgcHJvcHM6IENoYXJ0UHJvcHMgPSB7IH0pIHtcbiAgICBzdXBlcihzY29wZSwgaWQpO1xuICAgIHRoaXMubmFtZXNwYWNlID0gcHJvcHMubmFtZXNwYWNlO1xuICAgIHRoaXMuX2xhYmVscyA9IHByb3BzLmxhYmVscyA/PyB7fTtcblxuICAgIE9iamVjdC5kZWZpbmVQcm9wZXJ0eSh0aGlzLCBDSEFSVF9TWU1CT0wsIHsgdmFsdWU6IHRydWUgfSk7XG4gIH1cblxuICAvKipcbiAgICogTGFiZWxzIGFwcGxpZWQgdG8gYWxsIHJlc291cmNlcyBpbiB0aGlzIGNoYXJ0LlxuICAgKlxuICAgKiBUaGlzIGlzIGFuIGltbXV0YWJsZSBjb3B5LlxuICAgKi9cbiAgcHVibGljIGdldCBsYWJlbHMoKTogeyBbbmFtZTogc3RyaW5nXTogc3RyaW5nIH0ge1xuICAgIHJldHVybiB7IC4uLnRoaXMuX2xhYmVscyB9O1xuICB9XG5cbiAgLyoqXG4gICAqIEdlbmVyYXRlcyBhIGFwcC11bmlxdWUgbmFtZSBmb3IgYW4gb2JqZWN0IGdpdmVuIGl0J3MgY29uc3RydWN0IG5vZGUgcGF0aC5cbiAgICpcbiAgICogRGlmZmVyZW50IHJlc291cmNlIHR5cGVzIG1heSBoYXZlIGRpZmZlcmVudCBjb25zdHJhaW50cyBvbiBuYW1lc1xuICAgKiAoYG1ldGFkYXRhLm5hbWVgKS4gVGhlIHByZXZpb3VzIHZlcnNpb24gb2YgdGhlIG5hbWUgZ2VuZXJhdG9yIHdhc1xuICAgKiBjb21wYXRpYmxlIHdpdGggRE5TX1NVQkRPTUFJTiBidXQgbm90IHdpdGggRE5TX0xBQkVMLlxuICAgKlxuICAgKiBGb3IgZXhhbXBsZSwgYERlcGxveW1lbnRgIG5hbWVzIG11c3QgY29tcGx5IHdpdGggRE5TX1NVQkRPTUFJTiB3aGlsZVxuICAgKiBgU2VydmljZWAgbmFtZXMgbXVzdCBjb21wbHkgd2l0aCBETlNfTEFCRUwuXG4gICAqXG4gICAqIFNpbmNlIHRoZXJlIGlzIG5vIGZvcm1hbCBzcGVjaWZpY2F0aW9uIGZvciB0aGlzLCB0aGUgZGVmYXVsdCBuYW1lXG4gICAqIGdlbmVyYXRpb24gc2NoZW1lIGZvciBrdWJlcm5ldGVzIG9iamVjdHMgaW4gY2RrOHMgd2FzIGNoYW5nZWQgdG8gRE5TX0xBQkVMLFxuICAgKiBzaW5jZSBpdOKAmXMgdGhlIGNvbW1vbiBkZW5vbWluYXRvciBmb3IgYWxsIGt1YmVybmV0ZXMgcmVzb3VyY2VzXG4gICAqIChzdXBwb3NlZGx5KS5cbiAgICpcbiAgICogWW91IGNhbiBvdmVycmlkZSB0aGlzIG1ldGhvZCBpZiB5b3Ugd2lzaCB0byBjdXN0b21pemUgb2JqZWN0IG5hbWVzIGF0IHRoZVxuICAgKiBjaGFydCBsZXZlbC5cbiAgICpcbiAgICogQHBhcmFtIGFwaU9iamVjdCBUaGUgQVBJIG9iamVjdCB0byBnZW5lcmF0ZSBhIG5hbWUgZm9yLlxuICAgKi9cbiAgcHVibGljIGdlbmVyYXRlT2JqZWN0TmFtZShhcGlPYmplY3Q6IEFwaU9iamVjdCkge1xuICAgIHJldHVybiBOYW1lcy50b0Ruc0xhYmVsKGFwaU9iamVjdCk7XG4gIH1cblxuICAvKipcbiAgICogQ3JlYXRlIGEgZGVwZW5kZW5jeSBiZXR3ZWVuIHRoaXMgQ2hhcnQgYW5kIG90aGVyIGNvbnN0cnVjdHMuXG4gICAqIFRoZXNlIGNhbiBiZSBvdGhlciBBcGlPYmplY3RzLCBDaGFydHMsIG9yIGN1c3RvbS5cbiAgICpcbiAgICogQHBhcmFtIGRlcGVuZGVuY2llcyB0aGUgZGVwZW5kZW5jaWVzIHRvIGFkZC5cbiAgICovXG4gIHB1YmxpYyBhZGREZXBlbmRlbmN5KC4uLmRlcGVuZGVuY2llczogSUNvbnN0cnVjdFtdKSB7XG4gICAgTm9kZS5vZih0aGlzKS5hZGREZXBlbmRlbmN5KC4uLmRlcGVuZGVuY2llcyk7XG4gIH1cblxuICAvKipcbiAgICogUmVuZGVycyB0aGlzIGNoYXJ0IHRvIGEgc2V0IG9mIEt1YmVybmV0ZXMgSlNPTiByZXNvdXJjZXMuXG4gICAqIEByZXR1cm5zIGFycmF5IG9mIHJlc291cmNlIG1hbmlmZXN0c1xuICAgKi9cbiAgcHVibGljIHRvSnNvbigpOiBhbnlbXSB7XG4gICAgcmV0dXJuIEFwcC5fc3ludGhDaGFydCh0aGlzKTtcbiAgfVxufVxuXG4iXX0=
package/lib/cron.d.ts ADDED
@@ -0,0 +1,76 @@
1
+ /**
2
+ * Represents a cron schedule
3
+ */
4
+ export declare class Cron {
5
+ /**
6
+ * Create a cron schedule which runs every minute
7
+ */
8
+ static everyMinute(): Cron;
9
+ /**
10
+ * Create a cron schedule which runs every hour
11
+ */
12
+ static hourly(): Cron;
13
+ /**
14
+ * Create a cron schedule which runs every day at midnight
15
+ */
16
+ static daily(): Cron;
17
+ /**
18
+ * Create a cron schedule which runs every week on Sunday
19
+ */
20
+ static weekly(): Cron;
21
+ /**
22
+ * Create a cron schedule which runs first day of every month
23
+ */
24
+ static monthly(): Cron;
25
+ /**
26
+ * Create a cron schedule which runs first day of January every year
27
+ */
28
+ static annually(): Cron;
29
+ /**
30
+ * Create a custom cron schedule from a set of cron fields
31
+ */
32
+ static schedule(options: CronOptions): Cron;
33
+ /**
34
+ * Retrieve the expression for this schedule
35
+ */
36
+ readonly expressionString: string;
37
+ constructor(cronOptions?: CronOptions);
38
+ }
39
+ /**
40
+ * Options to configure a cron expression
41
+ *
42
+ * All fields are strings so you can use complex expressions. Absence of
43
+ * a field implies '*'
44
+ */
45
+ export interface CronOptions {
46
+ /**
47
+ * The minute to run this rule at
48
+ *
49
+ * @default - Every minute
50
+ */
51
+ readonly minute?: string;
52
+ /**
53
+ * The hour to run this rule at
54
+ *
55
+ * @default - Every hour
56
+ */
57
+ readonly hour?: string;
58
+ /**
59
+ * The day of the month to run this rule at
60
+ *
61
+ * @default - Every day of the month
62
+ */
63
+ readonly day?: string;
64
+ /**
65
+ * The month to run this rule at
66
+ *
67
+ * @default - Every month
68
+ */
69
+ readonly month?: string;
70
+ /**
71
+ * The day of the week to run this rule at
72
+ *
73
+ * @default - Any day of the week
74
+ */
75
+ readonly weekDay?: string;
76
+ }