https://github.com/mikaello/rescript-jest-date-mock

ReScript bindings for jest-date-mock. Mock Js.Date.t when using Jest.
https://github.com/mikaello/rescript-jest-date-mock

Last synced: 23 days ago
JSON representation

ReScript bindings for jest-date-mock. Mock Js.Date.t when using Jest.

• Host: GitHub
• URL: https://github.com/mikaello/rescript-jest-date-mock
• Owner: mikaello
• License: mit
• Created: 2019-07-05T16:48:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-13T12:03:25.000Z (4 months ago)
• Last Synced: 2024-10-11T12:09:09.944Z (3 months ago)
• Language: ReScript
• Homepage:
• Size: 495 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rescript-jest-date-mock

[![NPM version](http://img.shields.io/npm/v/rescript-jest-date-mock.svg)](https://www.npmjs.org/package/rescript-jest-date-mock)

[![Build Status](https://travis-ci.com/mikaello/rescript-jest-date-mock.svg?branch=master)](https://travis-ci.com/mikaello/rescript-jest-date-mock)

ReScript bindings for [jest-date-mock](https://github.com/hustcc/jest-date-mock). Use it to mock `Js.Date.t` when using Jest.

## Getting started

```

yarn add rescript-jest-date-mock

```

Then add `rescript-jest-date-mock` as a dependency to `bsconfig.json`:

```diff

"bs-dependencies": [

+  "rescript-jest-date-mock"

]

```

And add `jest-date-mock` to Jest setup files in `package.json` (you will need to add the `"jest"`-part to `package.json` if you don't have it already):

```diff

"jest": {

  "setupFiles": [

+    "jest-date-mock"

  ]

}

```

There is also other ways, check out the [setup sections](https://github.com/hustcc/jest-date-mock#setup) in jest-date-mock.

## Example

```reason

open RescriptJestDateMock

advanceTo(Js.Date.makeWithYMD(~year=2010.0, ~month=5.0, ~date=27.0, ()));

Js.log(Js.Date.make() |> Js.Date.toUTCString);

// => Sat, 26 Jun 2010 22:00:00 GMT

advanceBy(3 * 60 * 1000); // advanceBy 3 minutes (given in milliseconds)

Js.log(Js.Date.make() |> Js.Date.toUTCString);

// => Sat, 26 Jun 2010 22:03:00 GMT

clear(); // shut down mock system, Js.Date should now be as before

Js.log(Js.Date.make() |> Js.Date.toUTCString);

// => Sat, 06 Jul 2019 07:01:41 GMT

```

## Contribute

- If you find bugs or want to improve this library, feel free to open an issue or PR.

- If you are upgrading any dependencies, please use yarn so `yarn.lock` is updated.

- Try to adhere to [Angular commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guideline).

## Alternatives

There is some tips in the post "[Mocking/stubbing the current Date in Jest tests](https://codewithhugo.com/mocking-the-current-date-in-jest-tests/)" by Hugo Di Francesco.