blob: d4dd0bf9db473b167ce7046cc648e520f936ddcd (
plain)
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
|
# time-stamp [](https://www.npmjs.com/package/time-stamp) [](https://npmjs.org/package/time-stamp) [](https://travis-ci.org/jonschlinkert/time-stamp)
> Get a formatted timestamp.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install time-stamp --save
```
## Usage
```js
var timestamp = require('time-stamp');
timestamp();
//=> '2015:04:01'
timestamp('YYYY:MM:DD');
//=> '2015:04:01'
timestamp('[YYYY:MM:DD]');
//=> '[2015:04:01]'
timestamp('YYYY/MM/DD');
//=> '2015/04/01'
timestamp('YYYY:MM');
//=> '2015:04'
timestamp('YYYY');
//=> '2015'
timestamp('MM');
//=> '04'
timestamp('DD');
//=> '01'
timestamp('HH');
//=> '01'
timestamp('mm');
//=> '59'
timestamp('ss');
//=> '09'
timestamp('ms');
//=> '783'
```
**Valid patterns**
* `YYYY`: full year (ex: **2015**)
* `MM`: month (ex: **04**)
* `DD`: day (ex: **01**)
* `HH`: hours (ex: **12**)
* `mm`: minutes (ex: **59**)
* `ss`: seconds (ex: **09**)
* `ms`: milliseconds (ex: **532**)
## Related projects
You might also be interested in these projects:
* [days](https://www.npmjs.com/package/days): Days of the week. | [homepage](https://github.com/jonschlinkert/days)
* [iso-week](https://www.npmjs.com/package/iso-week): Get the ISO week of the year. | [homepage](https://github.com/jonschlinkert/iso-week)
* [month](https://www.npmjs.com/package/month): Get the name or number of the current month or any month of the year. | [homepage](https://github.com/datetime/month)
* [months](https://www.npmjs.com/package/months): Months of the year. | [homepage](https://github.com/jonschlinkert/months)
* [o-clock](https://www.npmjs.com/package/o-clock): Simple utility for displaying the time in 12-hour clock format. | [homepage](https://github.com/jonschlinkert/o-clock)
* [seconds](https://www.npmjs.com/package/seconds): Get the number of seconds for a minute, hour, day and week. | [homepage](https://github.com/jonschlinkert/seconds)
* [week](https://www.npmjs.com/package/week): Get the current week number. | [homepage](https://github.com/jonschlinkert/week)
* [weekday](https://www.npmjs.com/package/weekday): Get the name and number of the current weekday. Or get the name of the… [more](https://www.npmjs.com/package/weekday) | [homepage](https://github.com/jonschlinkert/weekday)
* [year](https://www.npmjs.com/package/year): Simple utility to get the current year with 2 or 4 digits. | [homepage](https://github.com/jonschlinkert/year)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/time-stamp/issues/new).
## Building docs
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
```sh
$ npm install verb && npm run docs
```
Or, if [verb](https://github.com/verbose/verb) is installed globally:
```sh
$ verb
```
## Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
## Author
**Jon Schlinkert**
Follow me on GitHub or Twitter for updates about time-stamp and my other libraries:
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/time-stamp/blob/master/LICENSE).
***
_This file was generated by [verb](https://github.com/verbose/verb), v, on April 07, 2016._
|
