Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rvboris/koa-useragent
Koa user-agent middleware
https://github.com/rvboris/koa-useragent
koa koa-useragent middleware
Last synced: 2 months ago
JSON representation
Koa user-agent middleware
- Host: GitHub
- URL: https://github.com/rvboris/koa-useragent
- Owner: rvboris
- License: mit
- Created: 2014-07-04T00:11:36.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T12:13:42.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T23:05:44.530Z (8 months ago)
- Topics: koa, koa-useragent, middleware
- Language: TypeScript
- Homepage:
- Size: 1.21 MB
- Stars: 57
- Watchers: 2
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
- awesome-koa - koa-useragent - 快速显露user-agent的中间件。   (仓库 / 中间件)
README
koa-useragent
=====
[](https://greenkeeper.io/)
**Fast Middleware exposing user-agent for [koa.js](http://koajs.com/) based on [express-useragent](https://github.com/biggora/express-useragent)**
----
### Installation
$ npm install koa-useragent
### Usage overview
```js
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
```ts
import Koa, { BaseContext } from 'koa';
import { userAgent, UserAgentContext } from 'koa-useragent';
const app = new Koa();
app.use(userAgent);
app.use((ctx) => {
console.log(require('util').inspect(ctx.userAgent));
});
app.listen(3000);
```
Module provides details such as the following:
```js
{
"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 ([email protected]).
Based on [express-useragent](https://github.com/biggora/express-useragent) by Aleksej Gordejev ([email protected]).
### License
(The MIT License)
Copyright (c) 2019 Boris Ryabov
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](http://www.bsryabov.ru).
- Report issues on the [github issues](https://github.com/rvboris/koa-rvboris/issues) page.