/date-plus

A tree-shakeable Date util library

Primary LanguageTypeScriptMIT LicenseMIT

Date Plus

build status bundle min gzip size license github version npm version all time npm downloads
maintainability coverage

A simple library to assist with date manipulation, comprising of a series of simple functions for convenience.

Difference from date-fns

I didn't know about date-fns when I wrote this. Honestly, go use date-fns instead.

Installation

Download from NPM

# Using NPM
npm i @luke-zhang-04/dateplus --save

#using Yarn
yarn add @luke-zhang-04/dateplus

Get bundles with curl

curl -L https://github.com/Luke-zhang-04/date-plus/releases/download/v<VERSION_NAME>/dateplus.bundle.min.js -O js/dateplus.bundle.min.js # Download minified file (recommended)

curl -L https://github.com/Luke-zhang-04/date-plus/releases/download/v<VERSION_NAME>/dateplus.bundle.js -O js/dateplus.bundle.js # Download not minfiied file (not recommended for production)

Usage

Run in a node environment with a require or import statement

const {default: DatePlus} = require("@luke-zhang-04/dateplus")
import DatePlus from "@luke-zhang-04/dateplus"

const myDate = new DatePlus()

Run in a browser environment by either using webpack or an alternative on the previous solution, or by adding the dateplus.min.js to your javascript within the HTML by downloading it or using a CDN

<script src="js/dateplus.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/@luke-zhang-04/dateplus@4.0.0-beta2/dist/esm/dateplus.min.js"></script>

<script>
    const {default: DatePlus} = DatePlus
    const myDate = new DatePlus()
</script>

Documentation

For documentation, visit the dateplus wiki