Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smartin85/moment-immutable
Make moment.js immutable (moments and durations)
https://github.com/smartin85/moment-immutable
duration immutable momentjs plugin react
Last synced: 6 days ago
JSON representation
Make moment.js immutable (moments and durations)
- Host: GitHub
- URL: https://github.com/smartin85/moment-immutable
- Owner: smartin85
- License: mit
- Created: 2017-02-12T21:27:23.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T13:26:06.000Z (almost 2 years ago)
- Last Synced: 2024-11-03T15:09:00.192Z (13 days ago)
- Topics: duration, immutable, momentjs, plugin, react
- Language: JavaScript
- Size: 333 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# moment-immutable
[![MIT License][license-image]][license-url]
[![npm version][npm-image]][npm-url]
[![npm downloads][downloads-image]][npm-url]
[![Build Status][azure-pipeline-image]][azure-pipeline-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![Buy me a coffee][buy-me-a-coffee-image]][buy-me-a-coffee-url]
Make moment.js immutable (moments and durations)
## Getting Started
moment-immutable can be included in your app by different ways:
### Node.js
moment-immutable can be installed with npm and required into a script:
```
npm install --save moment-immutable
```
```js
var moment = require('moment');
require('moment-immutable');
```
### Browser
Just include the momentjs script, all your other moment.js-plugins and then the moment-immutable script:
```html
```
### Browser with Require.js
```js
define(["moment", "moment-immutable"], function (moment) {
// you probably won´t need a reference to moment-immutable istself, so include it last
});
```
### Bower
```
bower install --save moment-immutable
```
## Working without moment-immutable
```js
var january1st = moment("2017-01-01");
var february1st = january1st.add(1, "month");
january1st.format(); // "2017-02-01T00:00:00+01:00" - damn
february1st.format(); // "2017-02-01T00:00:00+01:00"
```
## Working with moment-immutable
```js
var january1st = moment("2017-01-01");
var february1st = january1st.add(1, "month");
january1st.format(); // "2017-01-01T00:00:00+01:00" - yeah
february1st.format(); // "2017-02-01T00:00:00+01:00"
```
## Converting mutable methods of other plugins to immutable methods
By default moment-immutable is aware of all the mutable methods of moment.js (moments and durations) and moment-timezone.
For converting mutable methods of other plugins to immutable methods you can do this:
```js
// If it is a method on moment-objects:
moment.immutable.addMomentMutable('period', 1); // makes the period-function immutable if it has at least 1 parameter
// If it is a method on a moment-duration-object
moment.immutable.addDurationMutable('set', 0); // makes the set-function immutable
```
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: LICENSE
[npm-image]: https://badge.fury.io/js/moment-immutable.svg
[npm-url]: https://www.npmjs.com/package/moment-immutable
[downloads-image]: https://img.shields.io/npm/dt/moment-immutable.svg
[coveralls-image]: https://coveralls.io/repos/github/smartin85/moment-immutable/badge.svg
[coveralls-url]: https://coveralls.io/github/smartin85/moment-immutable
[snyk-image]: https://snyk.io/test/github/smartin85/moment-immutable/badge.svg
[snyk-url]: https://snyk.io/test/github/smartin85/moment-immutable
[azure-pipeline-image]: https://dev.azure.com/smartin85/moment-immutable/_apis/build/status/smartin85.moment-immutable?branchName=master
[azure-pipeline-url]: https://dev.azure.com/smartin85/moment-immutable/_build/latest?definitionId=2&branchName=master
[buy-me-a-coffee-image]: https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png
[buy-me-a-coffee-url]: https://www.buymeacoffee.com/smartin