wimd

wimd

wimd stands for "what is my device?"

Basically the express-device gained life of it's own and I had to refactor the basic functionality (it makes sense). Many were using express-device only to identify the type of device and didn't want all the express stuff.

how to use it?

$ npm install wimd

Here's an example on how to use it:

var wimd = require('wimd');
var mydevice = wimd('put here user-agent string');

if(mydevice.is('bot'))
	// do something...
else
	// do another thing...

By doing this you're getting an object that have the following properties:

Name	Field Type	Description	Possible Values
type	string	It gets the device type for the parsed user-agent string	desktop, tv, tablet, phone or bot
model	string	It gets the device model name for the parsed user-agent string	Example: iPhone. If the option parseUserAgent is set to false, then it will return an empty string

It accepts an object with only the config options you which to override (go here for some examples). The ones you don't override it will use the default values. Here's the list with the available config options:

Name	Field Type	Description	Possible Values
emptyUserAgentDeviceType	string	Device type to be returned whenever the has an empty user-agent. Defaults to desktop.	desktop, tv, tablet, phone or bot
unknownUserAgentDeviceType	string	Device type to be returned whenever the user-agent is unknown. Defaults to phone.	desktop, tv, tablet, phone or bot
botUserAgentDeviceType	string	Device type to be returned whenever the user-agent belongs to a bot. Defaults to bot.	desktop, tv, tablet, phone or bot
parseUserAgent	string	Configuration to parse the user-agent string using the useragent npm package. It's needed in order to get the device name. Defaults to false.	true | false

contributors

Some contributed in the express-device repository.

• @rguerreiro
• @aledbf
• @ryansully
• @lyxsus
• @dsyph3r
• @davo11122
• @esco
• @Saicheg
• @brycekahle
• @manjeshpv
• @Sitebase
• @lennym

where to go from here?

Currently wimd is on version 0.5.0. In order to add more features I'm asking anyone to contribute with some ideas. You can do it by making some feature requests on the issues panel, but I prefer that you make your contribution with some pull requests ;)

license

(The MIT License)

Copyright (c) 2015 Rodrigo Guerreiro

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.