npm.io
0.1.8 • Published 1 year ago

@bonsai-components/detect-os

Licence
(MIT OR Apache-2.0)
Version
0.1.8
Deps
0
Size
10 kB
Vulns
0
Weekly
0

Bonsai Logo

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 browser
  • detectOSInNodeProcess - handles detection in node
  • detectOS - 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;
}

Keywords