pkg-2-readme.template.md

{{name}}

v{{version}}

Description

{{description}}

Please feel free to ask for modifications, fixes or do a PR to improve Detector behaviors or add detection rules

{{#author}}

Author

{{author_name}} {{/author}}

{{#badges}}

Badges

{{#add_nodeico}}{{/add_nodeico}}

{{#add_github_badges}} {{#add_github_stars}}{{/add_github_stars}} {{#add_github_forks}}{{/add_github_forks}} {{#add_github_issues}}{{/add_github_issues}} {{#add_github_license}}{{/add_github_license}}{{/add_github_badges}} {{#add_travis}}{{/add_travis}} {{#add_coverage}}{{/add_coverage}} {{/badges}}

Documentation

Check out the Latest Documentation here

{{#example}}

Example

Check out this Codepen example {{/example}}

Installation

This is a JS/TS module available through the npm registry.

It can be installed using either npm or yarn package managers.

npm i {{name}}

yarn add {{name}}

Usage

import { Detector } from 'detector-js';

const detector = new Detector();

// It's possible to specify a custom userAgent if needed
// const detector = new Detector('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0.3 Safari/605.1.15');

console.log(detector);
// {
//   engine:{
//     name:'WebKit',
//     version:'605.1.15'
//   },
//   browser:{
//     name:'Safari',
//     version:'12.0.3'
//   },
//   os:{
//     name:'macOS',
//     version:'10.14.3',
//     versionName:'Mojave'
//   },
//   cpu:{
//     platform:'MacIntel',
//     cores:1,
//     architecture:'x64',
//     vendor:'intel'
//   },
//   gpu:{
//     webGLVendor:'WebKit',
//     webGLRenderer:'WebKit WebGL',
//     vendor:'Intel Inc.',
//     model:'Intel Iris',
//     renderer:'Intel Iris OpenGL Engine'
//   },
//   platform:'desktop',
//     feature: {
//     pointerEnabled:false,
//     pixelRatio:1,
//     pointerLock:true,
//     quirksMode:false,
//     css3D:true,
//     cssTransform:true,
//     cssTransition:true,
//     deviceMotion:false,
//     deviceOrientation:false,
//     contextMenu:false,
//     classList:false,
//     placeholder:true,
//     viewportUnit:true,
//     remUnit:true,
//     canvas:true,
//     svg:true,
//     webGL:true,
//     webVR:false,
//     touch:false,
//     forceTouch:true,
//     srcset:true,
//     sizes:true,
//     pictureElement:true,
//     dialogElement:false,
//     addEventListener:true,
//     asyncScript:true,
//     battery:false,
//     cors:true,
//     deferScript:true,
//     file:true,
//     fileSystem:false,
//     fullscreen:true,
//     fullscreenKeyboard:true,
//     geolocation:true,
//     historyAPI:true,
//     littleEndian:false,
//     localStorage:true,
//     matchMedia:true,
//     querySelector:true,
//     querySelectorAll:true,
//     serviceWorker:true,
//     typedArray:true,
//     userMedia:false,
//     vibration:false,
//     worker:true,
//     audio:{
//       supported:true,
//       context:true,
//       formats:{
//         mp3:true,
//         webm:false,
//         ogg:false,
//         opus:false,
//         wav:true,
//         m4a:true
//       }
//     },
//     video:{
//       supported:true,
//       formats:{
//         mp4:true,
//         ogv:false,
//         webm:false
//       }
//     }
//   }
// }

Todo

• refine browsers regexes
• refine documentation
• implement modular custom build feature
• decide to implement or not device infos detection

Dependencies

{{#depDetails}}

• {{name}}: {{description}} {{/depDetails}} {{^depDetails}} None {{/depDetails}}

Dev Dependencies

{{#devDepDetails}}

• {{name}}: {{description}} {{/devDepDetails}} {{^devDepDetails}} None {{/devDepDetails}}

{{#scripts.test}}

Tests

npm install
npm test

{{/scripts.test}}

{{#testOutput}}

{{{testOutput}}}

{{/testOutput}}

{{#license}}

License

{{license}} {{/license}}

Powered By