https://github.com/videsk/window-node-polyfill

Polyfill of window in Nodejs for testing purpose
https://github.com/videsk/window-node-polyfill

javascript-library mocha nodejs window

Last synced: 3 months ago
JSON representation

Polyfill of window in Nodejs for testing purpose

• Host: GitHub
• URL: https://github.com/videsk/window-node-polyfill
• Owner: videsk
• License: lgpl-2.1
• Created: 2021-03-04T01:15:49.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-29T19:44:15.000Z (7 months ago)
• Last Synced: 2024-11-07T14:18:18.455Z (3 months ago)
• Topics: javascript-library, mocha, nodejs, window
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Window polyfill for NodeJS

Nodejs doesn't have `window` object (obviously, not?). So, when you want to test pure Javascript or Typescript code that have `window` dependencies like `localStorage` and many more that are only able on browsers, your tests will not works, because you will get the `XXXX is not defined` error.

So, this library was designed to use in Node testing environment with mocha, chai, etc. where have browsers APIs dependencies. Some features of browsers was don't do what do you want like `document.createElement('div')`, but will returns you an object where you have access to properties and functions.

If you don't use a `window` polyfill you will get an error like this:

```js

window is not defined

```

## How to use

First install as dev dependency, **never use in production server**:

```js

npm i @videsk/window-node-polyfill -D

```

Only need add on teh top of the test file, like this:

```js

require('@videsk/window-node-polyfill');

...

```

Then you can access to the current properties:

- `window`

- `window.localStorage`

- `window.sessionStorage`

- `document`

- `document.createElement`

- `document.body`

- `document.body.appendChild`

- `window.location`

- `window.top`

- `window.parent`

## Storage

```js

// window.localStorage or window.sessionStorage

window.localStorage.getItem('my-key');

window.localStorage.setItem('my-key', 'my-value');

window.localStorage.removeItem('my-key');

``` 

## Document

```js

const element = document.createElement('div');

typeof element // object

```

## Contributions

If you want add more properties, you're welcome, so send you PR or issue with feature request.

## Copyrights

LGPL-2.1 License - By Videsk™