1 | ## [![npm][npmjs-img]][npmjs-url] [![mit license][license-img]][license-url] [![build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![deps status][daviddm-img]][daviddm-url]
|
2 |
|
3 | > Get current week number of the current year,given Date format string or Date object.
|
4 |
|
5 | ## Install
|
6 | ```
|
7 | npm i --save current-week-number
|
8 | npm test
|
9 | current-week-number --help
|
10 | ```
|
11 |
|
12 |
|
13 | ## API
|
14 | > For more use-cases see the [tests](./test.js)
|
15 |
|
16 | ### [currentWeekNumber](./index.js#L40)
|
17 | > Get week number of the current date/year or given valid `Date` string format
|
18 |
|
19 | - `[date]` **{String}** every valid Date-ish string format
|
20 | - `return` **{Number}**
|
21 |
|
22 | **Example:**
|
23 |
|
24 | ```js
|
25 | var currentWeekNumber = require('current-week-number');
|
26 |
|
27 | // june 27, 2014
|
28 | currentWeekNumber();
|
29 | //=> 26
|
30 |
|
31 | currentWeekNumber('March 24, 2015');
|
32 | //=> 13
|
33 |
|
34 | currentWeekNumber(new Date('March 24, 2015'));
|
35 | //=> 13
|
36 |
|
37 | currentWeekNumber('03/24/2016');
|
38 | //=> 12, cuz' year is leap
|
39 |
|
40 | currentWeekNumber('August 07, 2015');
|
41 | //=> 32
|
42 |
|
43 | currentWeekNumber(new Date('August 07, 2016'));
|
44 | //=> 31
|
45 |
|
46 | currentWeekNumber('02/16/2015');
|
47 | //=> 8
|
48 |
|
49 | currentWeekNumber('September 15, 2126');
|
50 | //=> 37
|
51 |
|
52 | currentWeekNumber('02/17/2012');
|
53 | //=> 7
|
54 | ```
|
55 |
|
56 |
|
57 | ## CLI
|
58 | > You can just run `current-week-number --help` for more information
|
59 |
|
60 |
|
61 | ## Author
|
62 | **Charlike Mike Reagent**
|
63 | + [gratipay/tunnckoCore][author-gratipay]
|
64 | + [twitter/tunnckoCore][author-twitter]
|
65 | + [github/tunnckoCore][author-github]
|
66 | + [npmjs/tunnckoCore][author-npmjs]
|
67 | + [more ...][contrib-more]
|
68 |
|
69 |
|
70 | ## License [![MIT license][license-img]][license-url]
|
71 | Copyright (c) 2014-2015 [Charlike Mike Reagent][contrib-more], [contributors][contrib-graf].
|
72 | Released under the [`MIT`][license-url] license.
|
73 |
|
74 |
|
75 | [npmjs-url]: http://npm.im/current-week-number
|
76 | [npmjs-img]: https://img.shields.io/npm/v/current-week-number.svg?style=flat&label=current-week-number
|
77 |
|
78 | [coveralls-url]: https://coveralls.io/r/datetime/current-week-number?branch=master
|
79 | [coveralls-img]: https://img.shields.io/coveralls/datetime/current-week-number.svg?style=flat
|
80 |
|
81 | [license-url]: https://github.com/datetime/current-week-number/blob/master/license.md
|
82 | [license-img]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
|
83 |
|
84 | [travis-url]: https://travis-ci.org/datetime/current-week-number
|
85 | [travis-img]: https://img.shields.io/travis/datetime/current-week-number.svg?style=flat
|
86 |
|
87 | [daviddm-url]: https://david-dm.org/datetime/current-week-number
|
88 | [daviddm-img]: https://img.shields.io/david/dev/datetime/current-week-number.svg?style=flat
|
89 |
|
90 | [author-gratipay]: https://gratipay.com/tunnckoCore
|
91 | [author-twitter]: https://twitter.com/tunnckoCore
|
92 | [author-github]: https://github.com/tunnckoCore
|
93 | [author-npmjs]: https://npmjs.org/~tunnckocore
|
94 |
|
95 | [contrib-more]: http://j.mp/1stW47C
|
96 | [contrib-graf]: https://github.com/datetime/current-week-number/graphs/contributors
|
97 |
|
98 | ***
|
99 |
|
100 | _Powered and automated by [kdf](https://github.com/tunnckoCore), March 02, 2015_ |
\ | No newline at end of file |