├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── index.test-d.ts ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 16 14 | steps: 15 | - uses: actions/checkout@v2 16 | - uses: actions/setup-node@v2 17 | with: 18 | node-version: ${{ matrix.node-version }} 19 | - run: npm install 20 | - run: npm test 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | export interface Options { 2 | /** 3 | Note that the month is zero-index to be consistent with the native date methods. 4 | 5 | @default (new Date()).getUTCMonth() 6 | */ 7 | readonly month?: number; 8 | 9 | /** 10 | @default (new Date).getUTCFullYear() 11 | */ 12 | readonly year?: number; 13 | } 14 | 15 | /** 16 | Get the number of days in a month. 17 | 18 | @example 19 | ``` 20 | import monthDays from 'month-days'; 21 | 22 | monthDays({month: 1, year: 2016}); 23 | //=> 29 24 | ``` 25 | */ 26 | export default function monthDays(options?: Options): number; 27 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const isDefined = value => value !== undefined; 2 | 3 | export default function monthDays({month, year} = {}) { 4 | if (isDefined(month) && typeof month !== 'number') { 5 | throw new TypeError(`Expected \`month\` to be of type \`number\`, got \`${typeof month}\``); 6 | } 7 | 8 | if (isDefined(year) && typeof year !== 'number') { 9 | throw new TypeError(`Expected \`year\` to be of type \`number\`, got \`${typeof year}\``); 10 | } 11 | 12 | const now = new Date(); 13 | month = isDefined(month) ? month : now.getUTCMonth(); 14 | year = isDefined(year) ? year : now.getUTCFullYear(); 15 | 16 | return new Date(Date.UTC(year, month + 1, 0)).getUTCDate(); 17 | } 18 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import monthDays from './index.js'; 3 | 4 | expectType(monthDays()); 5 | expectType(monthDays({month: 1})); 6 | expectType(monthDays({month: 1, year: 2016})); 7 | expectType(monthDays({year: 2016})); 8 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "month-days", 3 | "version": "4.0.0", 4 | "description": "Get the number of days in a month", 5 | "license": "MIT", 6 | "repository": "sindresorhus/month-days", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": "^12.20.0 || ^14.13.1 || >=16.0.0" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava && tsd" 20 | }, 21 | "files": [ 22 | "index.js", 23 | "index.d.ts" 24 | ], 25 | "keywords": [ 26 | "month", 27 | "days", 28 | "year", 29 | "date", 30 | "utc", 31 | "number", 32 | "count" 33 | ], 34 | "devDependencies": { 35 | "ava": "^3.15.0", 36 | "tsd": "^0.18.0", 37 | "xo": "^0.45.0" 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # month-days 2 | 3 | > Get the number of days in a month 4 | 5 | ## Install 6 | 7 | ```sh 8 | npm install month-days 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import monthDays from 'month-days'; 15 | 16 | monthDays({month: 1, year: 2016}); 17 | //=> 29 18 | ``` 19 | 20 | ## API 21 | 22 | ### monthDays(options?) 23 | 24 | #### options 25 | 26 | Type: `object` 27 | 28 | ##### month 29 | 30 | Type: `number`\ 31 | Default: Current UTC month 32 | 33 | Note that the month is zero-index to be consistent with the native date methods. 34 | 35 | ##### year 36 | 37 | Type: `number`\ 38 | Default: Current UTC year 39 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import monthDays from './index.js'; 3 | 4 | test('main', t => { 5 | t.throws(() => { 6 | monthDays({month: '5'}); 7 | }, { 8 | instanceOf: TypeError, 9 | }); 10 | 11 | t.throws(() => { 12 | monthDays({month: false}); 13 | }, { 14 | instanceOf: TypeError, 15 | }); 16 | 17 | t.throws(() => { 18 | monthDays({month: 5, year: true}); 19 | }, { 20 | instanceOf: TypeError, 21 | }); 22 | 23 | t.is(monthDays({month: 5, year: 2014}), 30); 24 | t.is(monthDays({month: 5}), 30); 25 | t.true(monthDays() >= 28); 26 | t.is(monthDays({month: 0, year: 2015}), 31); 27 | }); 28 | --------------------------------------------------------------------------------