Package Exports
- @bonsai-components/detect-os
- @bonsai-components/detect-os/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@bonsai-components/detect-os) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Detect OS
Intro
This package aims to make detection of the user's operating system easy.
How to install
npm i @bonsai-components/detect-os
How to use
There are 3 different variants:
detectOSInBrowser
- handles detection in the browserdetectOSInNodeProcess
- handles detection in nodedetectOS
- universal detection (the most code delivered but handles universal usage)
All variants work the same way () => 'mac' | 'windows' | 'other'
. There is a const enum
for typescript users to take advantage of as well.
Common usage:
import { detectOS } from '@bonsai-components/detect-os';
switch (detectOS()) {
case 'mac':
// do something
break;
case 'windows':
// do something
break;
case 'other':
// do something
break;
}