UNPKG

plat

Version:

A tool for working with JavaScript platforms agnostically

github.com/jasonkuhrt/plat

jasonkuhrt/plat

60 lines (28 loc) • 1.3 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# plat [![build status](https://secure.travis-ci.org/jasonkuhrt/plat.png)](http://travis-ci.org/jasonkuhrt/plat) A tool for working with JavaScript platforms agnostically ## Installation Server: npm install --save plat Client: component install jasonkuhrt/plat ## API ##### .isClient :: Bool Is `true` if the JavaScript is executing in a browser. `false` otherwise. ##### .isServer :: Bool Is `true` if the JavaScript is executing in NodeJS. `false` otherwise. ##### .platform :: String Is the label of the platform that the JavaScript is executing on; may be: `browser`, `node`. ##### .GLOBE | .globe :: Object Is a reference to the global scope. `window` in browsers, `GLOBAL` in NodeJS. ## Guide ##### Throwing If `plat` cannot determine the platform being used it will throw an error to let you know. At this point you should investigate why or create an issue/pull-request to justify and support your use-case/platform. The point is that `plat` will protect your code from executing in ambiguous execution contexts wherein e.g. you think you're in the server but not, etc. ##### Supported Platforms Currently supported: - Browsers - NodeJS More platform support is welcome by those that know how to unambiguously test for such contexts.