koa-useragent

Fast Middleware exposing user-agent for koa.js based on express-useragent

Installation

$ npm install koa-useragent

Usage overview

const koa = require('koa');
const app = koa.app();
const { userAgent } = require('koa-useragent');

app.use(userAgent);

app.use(async (ctx, next) {
  console.log(require('util').inspect(ctx.userAgent));
});

app.listen(3000);

Typescript example

import Koa, { BaseContext } from 'koa';
import { userAgent, UserAgentContext } from 'koa-useragent';

const app = new Koa();

app.use(userAgent);

app.use<BaseContext, UserAgentContext>((ctx) => {
  console.log(require('util').inspect(ctx.userAgent));
});

app.listen(3000);

Module provides details such as the following:

{
  "isMobile":false,
  "isDesktop":true,
  "isBot":false,
  .....
  "browser":"Chrome",
  "version":"17.0.963.79",
  "os":"Windows 7",
  "platform":"Microsoft Windows",
  "source":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.79 Safari/535.11"
}

Typescript support

From version 2.1.0 the library has rewritten in typescript. Definitions files distribute with source files.

From version 1.2.0, the library has type typescript definition file. You can install them from npm.

npm install --save-dev @types/koa-useragent

Author

Boris Ryabov (contact@bsryabov.ru).

Based on express-useragent by Aleksej Gordejev (aleksej@gordejev.lv).

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Resources

Visit the author website.
Report issues on the github issues page.

koa-useragentKoa user-agent middleware