Skip to content

Commit da067fb

Browse files
merenciamerencia
committed
new release
1 parent 423ba86 commit da067fb

3 files changed

Lines changed: 54 additions & 42 deletions

File tree

‎app.min.js‎

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎app.min.js.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/index.html‎

Lines changed: 50 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title></title><meta content="width=device-width,initial-scale=1,user-scalable=yes" name="viewport"><meta content="no-cache" http-equiv="cache-control"><meta content="max-age=0" http-equiv="cache-control"><meta content="0" http-equiv="expires"><meta content="Tue, 01 Jan 1980 1:00:00 GMT" http-equiv="expires"><meta content="no-cache" http-equiv="pragma"><link href="/app.min.css" rel="stylesheet"></head><body><div><div class="menu"><div class="container"><div class="menu-items"><div class="brand"><a href="/" class="router-link-active"><img src="/img/logo.png"> <span class="name">node-cron</span></a></div><div class="links"><a href="/docs" class="router-link-exact-active router-link-active">Docs</a> <a href="https://github.com/node-cron/node-cron" target="_blank">Github</a></div></div></div></div><div><div class="container"><div class="docs-container"><div class="docs-menu-container"><div class="docs-menu-menu"><ul class="docs-menu"><li><a href="/docs#getting-started">Getting Started</a></li><li><a href="/docs#cron-syntax">Cron Syntax</a></li></ul></div></div><div class="docs-content-container"><h1>Documentation</h1><p>The node-cron module is tiny task scheduler in pure JavaScript for node.js based on GNU crontab. This module allows you to schedule task in node.js using full crontab syntax.</p><div id="getting-started"><h2>Getting Started</h2><p>Install node-cron using npm: <span class="code-inline">$ npm install --save node-cron</span></p><p>Import node-cron and schedule a task:<pre> <code>
2-
var cron = require('node-cron');
1+
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title></title><meta content="width=device-width,initial-scale=1,user-scalable=yes" name="viewport"><meta content="no-cache" http-equiv="cache-control"><meta content="max-age=0" http-equiv="cache-control"><meta content="0" http-equiv="expires"><meta content="Tue, 01 Jan 1980 1:00:00 GMT" http-equiv="expires"><meta content="no-cache" http-equiv="pragma"><link href="/app.min.css" rel="stylesheet"></head><body><div><div class="menu"><div class="container"><div class="menu-items"><div class="brand"><a href="/" class="router-link-active"><img src="/img/logo.png"> <span class="name">node-cron</span></a></div><div class="links"><a href="/docs" class="router-link-exact-active router-link-active">Docs</a> <a href="https://github.com/node-cron/node-cron" target="_blank">Github</a></div></div></div></div><div><div class="container"><div class="docs-container"><div class="docs-menu-container"><div class="docs-menu-menu"><ul class="docs-menu"><li><a href="/docs#getting-started">Getting Started</a></li><li><a href="/docs#cron-syntax">Cron Syntax</a></li></ul></div></div><div class="docs-content-container"><h1>Documentation</h1><p>The node-cron module is tiny task scheduler in pure JavaScript for node.js based on GNU crontab. This module allows you to schedule task in node.js using full crontab syntax.</p><div id="getting-started"><h2>Getting Started</h2><p>Install node-cron using npm: <span class="code-inline">$ npm install --save node-cron</span></p><p>Import node-cron and schedule a task:<pre> <code>
2+
3+
<span class="token keyword">var</span> cron <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">'node-cron'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
34

4-
cron.schedule('* * * * *', () => {
5-
console.log('running a task every minute');
6-
});
7-
</code>
8-
</pre></p></div><div id="cron-syntax"><h2>Cron Syntax</h2><p>This is a quick reference to cron syntax and also shows the options supported by node-cron.</p><h3>Allowed fields</h3><pre> <code>
5+
cron<span class="token punctuation">.</span><span class="token function">schedule</span><span class="token punctuation">(</span><span class="token string">'* * * * *'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
6+
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'running a task every minute'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
7+
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
8+
9+
</code>
10+
</pre></p></div><div id="cron-syntax"><h2>Cron Syntax</h2><p>This is a quick reference to cron syntax and also shows the options supported by node-cron.</p><h3>Allowed fields</h3><pre> <code>
911
# ┌────────────── second (optional)
1012
# │ ┌──────────── minute
1113
# │ │ ┌────────── hour
@@ -16,39 +18,49 @@
1618
# │ │ │ │ │ │
1719
# * * * * * *
1820
</code>
19-
</pre><h3>Allowed values</h3><table><thead><tr><th>fields</th><th>values</th></tr></thead><tbody><tr><td>second</td><td>0-59</td></tr><tr><td>minute</td><td>0-59</td></tr><tr><td>hour</td><td>0-23</td></tr><tr><td>day of month</td><td>1-31</td></tr><tr><td>month</td><td>1-12 (or names, e.g: Jan, Feb, March, April)</td></tr><tr><td>day of week</td><td>0-7 (0 or 7 are sunday, or names, e.g. Sunday, Monday, Tue, Wed)</td></tr></tbody></table><h3>Using multiples values</h3>You may use multiples values separated by comma:<pre> <code>
20-
var cron = require('node-cron');
21+
</pre><h3>Allowed values</h3><table><thead><tr><th>fields</th><th>values</th></tr></thead><tbody><tr><td>second</td><td>0-59</td></tr><tr><td>minute</td><td>0-59</td></tr><tr><td>hour</td><td>0-23</td></tr><tr><td>day of month</td><td>1-31</td></tr><tr><td>month</td><td>1-12 (or names, e.g: Jan, Feb, March, April)</td></tr><tr><td>day of week</td><td>0-7 (0 or 7 are sunday, or names, e.g. Sunday, Monday, Tue, Wed)</td></tr></tbody></table><h3>Using multiples values</h3>You may use multiples values separated by comma:<pre> <code>
22+
23+
<span class="token keyword">var</span> cron <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">'node-cron'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
2124

22-
cron.schedule('1,2,4,5 * * * *', () => {
23-
console.log('running every minute 1, 2, 4 and 5');
24-
});
25-
</code>
26-
</pre><h3>Using ranges</h3>You may also define a range of values:<pre> <code>
27-
var cron = require('node-cron');
25+
cron<span class="token punctuation">.</span><span class="token function">schedule</span><span class="token punctuation">(</span><span class="token string">'1,2,4,5 * * * *'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
26+
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'running every minute 1, 2, 4 and 5'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
27+
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
28+
29+
</code>
30+
</pre><h3>Using ranges</h3>You may also define a range of values:<pre> <code>
31+
32+
<span class="token keyword">var</span> cron <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">'node-cron'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
2833

29-
cron.schedule('1-5 * * * *', () => {
30-
console.log('running every minute to 1 from 5');
31-
});
32-
</code>
33-
</pre><h3>Using step values</h3>Step values can be used in conjunction with ranges, following a range with '/' and a number. e.g: 1-10/2 that is the same as 2,4,6,8,10. Steps are also permitted after an asterisk, so if you want to say “every two minutes”, just use */2.<pre> <code>
34-
var cron = require('node-cron');
34+
cron<span class="token punctuation">.</span><span class="token function">schedule</span><span class="token punctuation">(</span><span class="token string">'1-5 * * * *'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
35+
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'running every minute to 1 from 5'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
36+
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
37+
38+
</code>
39+
</pre><h3>Using step values</h3>Step values can be used in conjunction with ranges, following a range with '/' and a number. e.g: 1-10/2 that is the same as 2,4,6,8,10. Steps are also permitted after an asterisk, so if you want to say “every two minutes”, just use */2.<pre> <code>
40+
41+
<span class="token keyword">var</span> cron <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">'node-cron'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
3542

36-
cron.schedule('*/2 * * * *', () => {
37-
console.log('running a task every two minutes');
38-
});
39-
</code>
40-
</pre><h3>Using names</h3>For month and week day you also may use names or short names. e.g:<pre> <code>
41-
var cron = require('node-cron');
43+
cron<span class="token punctuation">.</span><span class="token function">schedule</span><span class="token punctuation">(</span><span class="token string">'*/2 * * * *'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
44+
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'running a task every two minutes'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
45+
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
46+
47+
</code>
48+
</pre><h3>Using names</h3>For month and week day you also may use names or short names. e.g:<pre> <code>
49+
50+
<span class="token keyword">var</span> cron <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">'node-cron'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
4251

43-
cron.schedule('* * * January,September Sunday', () => {
44-
console.log('running on Sundays of January and September');
45-
});
46-
</code>
47-
</pre>Or with short names:<pre> <code>
48-
var cron = require('node-cron');
52+
cron<span class="token punctuation">.</span><span class="token function">schedule</span><span class="token punctuation">(</span><span class="token string">'* * * January,September Sunday'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
53+
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'running on Sundays of January and September'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
54+
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
55+
56+
</code>
57+
</pre>Or with short names:<pre> <code>
58+
59+
<span class="token keyword">var</span> cron <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">'node-cron'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
4960

50-
cron.schedule('* * * Jan,Sep Sun', () => {
51-
console.log('running on Sundays of January and September');
52-
});
53-
</code>
54-
</pre></div></div></div></div></div></div><script src="/app.min.js"></script></body></html>
61+
cron<span class="token punctuation">.</span><span class="token function">schedule</span><span class="token punctuation">(</span><span class="token string">'* * * Jan,Sep Sun'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
62+
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'running on Sundays of January and September'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
63+
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
64+
65+
</code>
66+
</pre></div></div></div></div></div></div><script src="/app.min.js"></script></body></html>

0 commit comments

Comments
 (0)