# weekstart > Library to get first day of week. Latest version **2.0.0** (published 2023-02-24) · MIT license · 0 weekly downloads ## Install ```sh npm install weekstart pnpm add weekstart yarn add weekstart bun add weekstart ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.0 | | Published | 2023-02-24 | | First published | 2017-09-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 0 | | Unpacked size | 252.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 21 | | Author | Denis Sikuler | | Maintainers | gamtiq | | Keywords | week, start, first, day, locale, country, region | ## Links - npm: https://www.npmjs.com/package/weekstart - Repository: https://github.com/gamtiq/weekstart - Issues: https://github.com/gamtiq/weekstart/issues - npm.io page: https://npm.io/package/weekstart ## Alternatives - [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads - [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads - [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads - [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads - [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads ## Recent versions - 2.0.0 (latest) — 2023-02-24 - 1.1.0 — 2021-03-15 - 1.0.1 — 2019-10-19 - 1.0.0 — 2018-01-20 - 0.1.0 — 2017-09-07 ## README # weekstart [![NPM version](https://badge.fury.io/js/weekstart.png)](http://badge.fury.io/js/weekstart) Library to get first day of week. ```js getWeekStartByRegion('MAC'); // 0 getWeekStartByLocale('arq'); // 6 ``` The library is based on the following data from Unicode (especially from Common Locale Data Repository) and from ISO: * [https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_information.html](https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_information.html) * [https://github.com/unicode-org/cldr-json/blob/main/cldr-json/cldr-core/supplemental/weekData.json](https://github.com/unicode-org/cldr-json/blob/main/cldr-json/cldr-core/supplemental/weekData.json) * [https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_language_information.html](https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_language_information.html) * [https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/language_territory_information.html](https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/language_territory_information.html) * [https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/scripts_languages_and_territories.html](https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/scripts_languages_and_territories.html) * [http://www.unicode.org/reports/tr35/tr35.html#Unicode_Language_and_Locale_Identifiers](http://www.unicode.org/reports/tr35/tr35.html#Unicode_Language_and_Locale_Identifiers) * [https://www.iso.org/iso-3166-country-codes.html](https://www.iso.org/iso-3166-country-codes.html) There are 2 variants of the library having identical [API](#api): * `main` - uses base mapping of language code to country code from [langRegionMap](https://github.com/gamtiq/weekstart/blob/master/src/langRegionMap.js). * `full` - uses full mapping of language code to country code from [fullLangRegionMap](https://github.com/gamtiq/weekstart/blob/master/src/fullLangRegionMap.js). [langRegionMap](https://github.com/gamtiq/weekstart/blob/master/src/langRegionMap.js) contains only main language codes. It is data subset from [fullLangRegionMap](https://github.com/gamtiq/weekstart/blob/master/src/fullLangRegionMap.js). ## Table of contents * [Installation](#install) * [Usage](#usage) * [Examples](#examples) * [API](#api) * [Contributing](#contributing) * [License](#license) ## Installation [↑](#start) ### Node npm install weekstart ### [Bower](http://bower.io) bower install weekstart ### AMD/UMD, <script> Use `dist/main.js` or `dist/min/main.js` (minified version). Use `dist/full.js` or `dist/min/full.js` (minified version) when you need full locale data. ## Usage [↑](#start) ### ECMAScript 6 ```js import {getWeekStartByLocale, getWeekStartByRegion} from 'weekstart'; ``` If you need full data: ```js import {getWeekStartByLocale, getWeekStartByRegion} from 'weekstart/full'; ``` ### Node ```js const getWeekStartByLocale = require('weekstart').getWeekStartByLocale; const getWeekStartByRegion = require('weekstart').getWeekStartByRegion; ``` If you need full data: ```js const getWeekStartByLocale = require('weekstart/full').getWeekStartByLocale; const getWeekStartByRegion = require('weekstart/full').getWeekStartByRegion; ``` ### AMD/UMD ```js define(['path/to/dist/main.js'], function(weekstart) { const getWeekStartByLocale = weekstart.getWeekStartByLocale; const getWeekStartByRegion = weekstart.getWeekStartByRegion; }); ``` If you need full data: ```js define(['path/to/dist/full.js'], function(weekstart) { const getWeekStartByLocale = weekstart.getWeekStartByLocale; const getWeekStartByRegion = weekstart.getWeekStartByRegion; }); ``` ### Bower, <script> ```html ``` If you need full data use `path/to/dist/full.js` instead of `path/to/dist/main.js`. ## Examples [↑](#start) ```js getWeekStartByRegion('dj'); // 6 getWeekStartByRegion('No'); // 1 getWeekStartByRegion('CAN'); // 0 getWeekStartByRegion(462); // 5 getWeekStartByLocale('Jam'); // 0 getWeekStartByLocale('Fa'); // 6 getWeekStartByLocale('vi'); // 1 getWeekStartByLocale('es_MX'); // 0 getWeekStartByLocale('az-Arab-IRN'); // 6 ``` In the following examples results are given for the function from `full.js`. The same calls for the function from `main.js` will return `1`. ```js getWeekStartByLocale('CCP'); // 0 getWeekStartByLocale('UZ-arab'); // 6 ``` ## API [↑](#start) #### getWeekStartByLocale(locale): number Return first day of week for locale identifier: 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday, 6 - Saturday. #### getWeekStartByRegion(regionCode): number Return first day of week for country/region code: 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday, 6 - Saturday. See [`docs`](https://gamtiq.github.io/weekstart/) for details. ## Contributing [↑](#start) In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code. ## License [↑](#start) Licensed under the [MIT license](https://github.com/gamtiq/weekstart/blob/master/LICENSE). --- _Source: https://npm.io/package/weekstart · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._