https://github.com/alessiofrittoli/date-utils
Lightweight TypeScript date utility functions library
https://github.com/alessiofrittoli/date-utils
dates datetime intl-dateformat relative-date timezones typescript
Last synced: about 2 months ago
JSON representation
Lightweight TypeScript date utility functions library
- Host: GitHub
- URL: https://github.com/alessiofrittoli/date-utils
- Owner: alessiofrittoli
- License: mit
- Created: 2024-11-26T19:25:26.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-03-19T18:51:52.000Z (3 months ago)
- Last Synced: 2025-03-19T18:55:15.302Z (3 months ago)
- Topics: dates, datetime, intl-dateformat, relative-date, timezones, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/package/@alessiofrittoli/date-utils
- Size: 253 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Date Utils 🗓️
[![NPM Latest Version][version-badge]][npm-url] [![Coverage Status][coverage-badge]][coverage-url] [![Socket Status][socket-badge]][socket-url] [![NPM Monthly Downloads][downloads-badge]][npm-url] [![Dependencies][deps-badge]][deps-url]
[![GitHub Sponsor][sponsor-badge]][sponsor-url]
[version-badge]: https://img.shields.io/npm/v/%40alessiofrittoli%2Fdate-utils
[npm-url]: https://npmjs.org/package/%40alessiofrittoli%2Fdate-utils
[coverage-badge]: https://coveralls.io/repos/github/alessiofrittoli/date-utils/badge.svg
[coverage-url]: https://coveralls.io/github/alessiofrittoli/date-utils
[socket-badge]: https://socket.dev/api/badge/npm/package/@alessiofrittoli/date-utils
[socket-url]: https://socket.dev/npm/package/@alessiofrittoli/date-utils/overview
[downloads-badge]: https://img.shields.io/npm/dm/%40alessiofrittoli%2Fdate-utils.svg
[deps-badge]: https://img.shields.io/librariesio/release/npm/%40alessiofrittoli%2Fdate-utils
[deps-url]: https://libraries.io/npm/%40alessiofrittoli%2Fdate-utils
[sponsor-badge]: https://img.shields.io/static/v1?label=Fund%20this%20package&message=%E2%9D%A4&logo=GitHub&color=%23DB61A2
[sponsor-url]: https://github.com/sponsors/alessiofrittoli
## Lightweight TypeScript date utility functions library
This lightweight TypeScript utility library comes with common and utility dates functions.
Everything is exported from the root of this library but specific paths can be used too (especially when dynamically importing functions and tree shaking has no effect).
### Table of Contents
- [Getting started](#getting-started)
- What's inside
- [Common utilities](https://github.com/alessiofrittoli/date-utils/blob/master/docs/common/README.md)
- [Formatting functions](https://github.com/alessiofrittoli/date-utils/blob/master/docs/format/README.md)
- [Timezone utilities](https://github.com/alessiofrittoli/date-utils/blob/master/docs/timezones/README.md)
- [Utility functions](https://github.com/alessiofrittoli/date-utils/blob/master/docs/utils/README.md)
- [Development](#development)
- [Install depenendencies](#install-depenendencies)
- [Build the source code](#build-the-source-code)
- [ESLint](#eslint)
- [Jest](#jest)
- [Contributing](#contributing)
- [Security](#security)
- [Credits](#made-with-)
---
### Getting started
Run the following command to start using `date-utils` in your projects:
```bash
npm i @alessiofrittoli/date-utils
```
or using `pnpm`
```bash
pnpm i @alessiofrittoli/date-utils
```
### Development
#### Install depenendencies
```bash
npm install
```
or using `pnpm`
```bash
pnpm i
```
#### Build the source code
Run the following command to test and build code for distribution.
```bash
pnpm build
```
#### [ESLint](https://www.npmjs.com/package/eslint)
warnings / errors check.
```bash
pnpm lint
```
#### [Jest](https://npmjs.com/package/jest)
Run all the defined test suites by running the following:
```bash
# Run tests and watch file changes.
pnpm test:watch
# Run tests in a CI environment.
pnpm test:ci
```
- See [`package.json`](./package.json) file scripts for more info.
Run tests with coverage.
An HTTP server is then started to serve coverage files from `./coverage` folder.
⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.
```bash
test:coverage:serve
```
---
### Contributing
Contributions are truly welcome!
Please refer to the [Contributing Doc](./CONTRIBUTING.md) for more information on how to start contributing to this project.
Help keep this project up to date with [GitHub Sponsor][sponsor-url].
[![GitHub Sponsor][sponsor-badge]][sponsor-url]
---
### Security
If you believe you have found a security vulnerability, we encourage you to **_responsibly disclose this and NOT open a public issue_**. We will investigate all legitimate reports. Email `[email protected]` to disclose any security vulnerabilities.
### Made with ☕
Alessio Frittoli
https://alessiofrittoli.it |
[email protected]