carbonjs

carbonjs

Typescript ready date library alternative to Moment.js

Carbon.js is a minimalist JavaScript library that parses, validates, manipulates, and displays dates and times for modern browsers with a largely Moment.js-compatible API.

Table of Content

• Features
• Getting Started
  • Installation
  • Usage
    • API
    • I18n
    • Plugin
• Versioning
• Authors
• License
• Support

Features

• :clock3: Familiar Moment.js API & patterns
• :muscle: Immutable
• :fire: Chainable
• :globe_with_meridians: I18n support
• :gear: Plugin support
• :gear: Calendar support (as part of plugin support)

Getting Started

Installation

npm i -s carbonjs

Usage

API

It's easy to use Carbon.js APIs to parse, validate, manipulate, and display dates and times.

import * as Carbon from "carbonjs";

Carbon.parse("2018-08-08"); // parse

new Carbon().format("{YYYY} MM-DDTHH:mm:ss SSS [Z] A"); // display

Carbon.parse().set("month", 3).month(); // get & set

new Carbon().add(1, "year"); // manipulate

Carbon.parse().isBefore(Carbon.parse()); // query

I18n

Day.js has great support for internationalization.

But none of them will be included in your build unless you use it.

import "carbonjs/lib/locales/es"; // load locale package on demand

Carbon.locale("es"); // use Spanish locale globally

Carbon.parse("2018-05-05").locale("zh-cn").format(); // use Chinese Simplified locale in a specific instance

Plugin

A plugin is an independent module that can be added to Day.js to extend functionality or add new features.

import * as advancedFormat from 'carbonjs/lib/plugins/advancedFormat' // load on demand

Carbon.extend(advancedFormat) // use plugin

Carbon.parse().format('Q Do k kk X x') // more available formats

:books:Full API Reference

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ardalan Amini - Owner/Developer - @ardalanamini

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Support

If my work helps you, please consider

Changelog

v1.0.0 - (2018-09-01)

• :tada: First release