www.aleph1.co.uk Git - yaffs-website/blob - node_modules/time-stamp/README.md

   1 # time-stamp [![NPM version](https://img.shields.io/npm/v/time-stamp.svg?style=flat)](https://www.npmjs.com/package/time-stamp) [![NPM downloads](https://img.shields.io/npm/dm/time-stamp.svg?style=flat)](https://npmjs.org/package/time-stamp) [![Build Status](https://img.shields.io/travis/jonschlinkert/time-stamp.svg?style=flat)](https://travis-ci.org/jonschlinkert/time-stamp)
   2
   3 > Get a formatted timestamp.
   4
   5 ## Install
   6
   7 Install with [npm](https://www.npmjs.com/):
   8
   9 ```sh
  10 $ npm install time-stamp --save
  11 ```
  12
  13 ## Usage
  14
  15 ```js
  16 var timestamp = require('time-stamp');
  17
  18 timestamp();
  19 //=> '2015:04:01'
  20
  21 timestamp('YYYY:MM:DD');
  22 //=> '2015:04:01'
  23
  24 timestamp('[YYYY:MM:DD]');
  25 //=> '[2015:04:01]'
  26
  27 timestamp('YYYY/MM/DD');
  28 //=> '2015/04/01'
  29
  30 timestamp('YYYY:MM');
  31 //=> '2015:04'
  32
  33 timestamp('YYYY');
  34 //=> '2015'
  35
  36 timestamp('MM');
  37 //=> '04'
  38
  39 timestamp('DD');
  40 //=> '01'
  41
  42 timestamp('HH');
  43 //=> '01'
  44
  45 timestamp('mm');
  46 //=> '59'
  47
  48 timestamp('ss');
  49 //=> '09'
  50
  51 timestamp('ms');
  52 //=> '783'
  53 ```
  54
  55 **Valid patterns**
  56
  57 * `YYYY`: full year (ex: **2015**)
  58 * `MM`: month (ex: **04**)
  59 * `DD`: day (ex: **01**)
  60 * `HH`: hours (ex: **12**)
  61 * `mm`: minutes (ex: **59**)
  62 * `ss`: seconds (ex: **09**)
  63 * `ms`: milliseconds (ex: **532**)
  64
  65 ## Related projects
  66
  67 You might also be interested in these projects:
  68
  69 * [days](https://www.npmjs.com/package/days): Days of the week. | [homepage](https://github.com/jonschlinkert/days)
  70 * [iso-week](https://www.npmjs.com/package/iso-week): Get the ISO week of the year. | [homepage](https://github.com/jonschlinkert/iso-week)
  71 * [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)
  72 * [months](https://www.npmjs.com/package/months): Months of the year. | [homepage](https://github.com/jonschlinkert/months)
  73 * [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)
  74 * [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)
  75 * [week](https://www.npmjs.com/package/week): Get the current week number. | [homepage](https://github.com/jonschlinkert/week)
  76 * [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)
  77 * [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)
  78
  79 ## Contributing
  80
  81 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/time-stamp/issues/new).
  82
  83 ## Building docs
  84
  85 Generate readme and API documentation with [verb](https://github.com/verbose/verb):
  86
  87 ```sh
  88 $ npm install verb && npm run docs
  89 ```
  90
  91 Or, if [verb](https://github.com/verbose/verb) is installed globally:
  92
  93 ```sh
  94 $ verb
  95 ```
  96
  97 ## Running tests
  98
  99 Install dev dependencies:
 100
 101 ```sh
 102 $ npm install -d && npm test
 103 ```
 104
 105 ## Author
 106
 107 **Jon Schlinkert**
 108
 109 Follow me on GitHub or Twitter for updates about time-stamp and my other libraries:
 110
 111 * [github/jonschlinkert](https://github.com/jonschlinkert)
 112 * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
 113
 114 ## License
 115
 116 Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
 117 Released under the [MIT license](https://github.com/jonschlinkert/time-stamp/blob/master/LICENSE).
 118
 119 ***
 120
 121 _This file was generated by [verb](https://github.com/verbose/verb), v, on April 07, 2016._