https://github.com/kiwiupover/ember-mockdate
Mock date
https://github.com/kiwiupover/ember-mockdate
Last synced: 2 months ago
JSON representation
Mock date
- Host: GitHub
- URL: https://github.com/kiwiupover/ember-mockdate
- Owner: kiwiupover
- License: mit
- Created: 2021-08-07T01:01:35.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-08T21:28:21.000Z (over 2 years ago)
- Last Synced: 2025-02-28T17:56:57.549Z (3 months ago)
- Language: JavaScript
- Size: 555 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-mockdate
Use [MockDate](https://github.com/boblauer/MockDate) within your Ember applications.
`ember-mockdate` is an updated version of the great [ember-mockdate-shim](https://github.com/Ticketfly/ember-mockdate-shim) using the same api.
## Compatibility
- Ember.js v3.16 or above
- Ember CLI v3.16 or above
- Node.js v10 or above
## Installation
```
ember install ember-mockdate
```
## Usage
MockDate's `set` and `reset` methods are renamed to `freezeDateAt` and `unfreezeDate` respectively.
```js
import { freezeDateAt, unfreezeDate } from 'ember-mockdate';
freezeDateAt(new Date('1/12/2017'));
unfreezeDate();
```
This is primarily useful for keeping the time data consistent between tests (ie: for visual diffs a la [Percy](https://percy.io/)). Any library methods that rely on `new Date()` will return consistent outputs. For example: [`moment()`](https://github.com/moment/moment/) and [`faker.date.recent`](https://github.com/Marak/faker.js/blob/master/lib/date.js#L66)
You can use this in the `beforeEach` and `afterEach` hooks of your tests, or anywhere else you want to freeze the date at, how ever many times you want!
Please note that acceptance test support is only available in Ember >2.15.1 as that is when `backburner.js` introduced the ability to make "now" configurable. More info [here](https://github.com/BackburnerJS/backburner.js/commit/a6fe19eb26c2b7ed8360de19ca0cc9ae5b05f297).
## Contributing
See the [Contributing](CONTRIBUTING.md) guide for details.
This repo is a fork of [ember-mockdate-shim](https://github.com/Ticketfly/ember-mockdate-shim). Thank you to all the [contributors](https://github.com/Ticketfly/ember-mockdate-shim/graphs/contributors).
## License
This project is licensed under the [MIT License](LICENSE.md).