Light

jedwatson / exenv Goto Github PK

View Code? Open in Web Editor NEW

233.0 6.0 19.0 7 KB

React's ExecutionEnvironment module extracted for use in other packages & components

License: Other

JavaScript 100.00%

exenv's Introduction

exenv

React's ExecutionEnvironment module extracted for use in other packages & components.

Usage

npm install exenv --save

var ExecutionEnvironment = require('exenv');

// You now have...
ExecutionEnvironment.canUseDOM             // is the DOM available? i.e window document etc. 
ExecutionEnvironment.canUseWorkers         // are Web Workers available?
ExecutionEnvironment.canUseEventListeners  // are Events available? i.e addEventListener etc.
ExecutionEnvironment.canUseViewport        // is there a viewport? i.e window.screen

Differences from React's ExecutionEnvironment

The ExecutionEnvironment lib in React 0.13 includes an isInWorker property, which is !canUseDOM. This is highly specific to React internals and probably (a) hacky and (b) not useful to other packages, so it has been left out. Please open an issue with your thoughts if you disagree or have a better idea.

Why?

A number of packages and components use React's private ExecutionEnvironment lib to detect available features, particularly to detect server-side rendering, e.g

canUseDOM = require('react/lib/ExecutionEnvironment').canUseDOM; // BAD

It is bad practice to use React internals and this is likely to be broken / disabled in the future.

Use this package instead!

exenv's People

Contributors

Stargazers

Watchers

Forkers

narrativescience-old liangklfang jacobangel ptzagk sayali10 acbullen jesseljohn realityking krufab md-azam12 gfx migueloller xxonline hronro rajnandigalla

exenv's Issues

License file doesn't include project copyright

The license file appears to be a verbatim copy of React's, but the index.js contains a different Copyright notice. I believe the BSD license file should contain the copyright notice for this project itself. If so, the copyright line from the source should just be added to/replace the existing one on the top of the LICENSE file, if it is intended to license this as the BSD 3-clause license.

using Jsdom causes, Incorrect Execution Environment

Hi, i am building a Universal app using react, and the issue is , i have to fake the window object using JSdom that is in return causing incorrect execution environment.

is there any workaround for it ?

below piece of code exactly determines if code is executing on node server or not, without using window object

var isNode=new Function("try {return this===global;}catch(e){return false;}");
isNode() //true if of node server else false

Add Universal Module Definition

I'd like to use this in one of my projects.

My environments are "classic" node and the browser without any module loader ( no browserify ).

Wrapping the module in an UMD would make it possible to use it in both env's.
I can also propose a PR if you like. :)

https://github.com/umdjs/umd

Is This Still Maintenance ?

just ask about support, if someday need help 💃 💃

No license

I would like to use this in a project, however because there is no license I'm unable.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.