{"_id":"@apilayer/userstack","_rev":"1-9fd2936cb28385b2b2b969f88c446275","name":"@apilayer/userstack","dist-tags":{"latest":"0.1.6"},"versions":{"0.1.6":{"name":"@apilayer/userstack","version":"0.1.6","author":{"name":"Samuel Oloruntoba","email":"github@kayandra.co","url":"https://kayandra.co"},"license":"MIT","dependencies":{"@types/node-fetch":"^2.5.0","node-fetch":"^2.5.0"},"gitHead":"e0a9510ba4e021cc2692311d4869e451bef33799","publishConfig":{"access":"public"},"description":"Userstack provides an API to Detect any Browser, Device & OS in Real-Time","_id":"@apilayer/userstack@0.1.6","_nodeVersion":"10.16.3","_npmVersion":"lerna/3.16.4/node@v10.16.3+x64 (linux)","dist":{"integrity":"sha512-GBZqmnrt/eB3Zvxdu/tPgT3pgJLCeGkYLKVngcVQrZzrCT8Ktb6M80P+Irr6cNHILslAoTI8yV0S5NNXIrnvZQ==","shasum":"1c44462675c2bbb9cb733ca172dc3b1560a2510a","tarball":"https://registry.npmjs.org/@apilayer/userstack/-/userstack-0.1.6.tgz","fileCount":5,"unpackedSize":6876,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkzKjCRA9TVsSAnZWagAATfgQAJ3NWFUhLjQIAdAA5dcu\natcMfSP+RL7G3SwdEfJVJzJMKWb5JhtacY2ynD5xLRN51C9lr5ZZxagAD5AN\neU0IZYmZTVmkIocTb1Bl/c6QMqM/yeJOVsrmXDJqUmr81Bo0HejPjXPG5UJc\nNqw+ndqr/wqvllOR43uXYE1mXkv98jPBMC4HPTDhgysQmjTjtDUkI6wle1Vp\n5jo4MtUWaqk1RGvd0YudGIYFnqh7wqK3Auc3KG2x3AFHbzrBFPWfm2p/LJX9\nx8G2r8+vM0Jy6DoeN/Zyc9hDJOZHUhL4yxBgMq2yq5psJ+Ev6prZtwRsIvO8\nlaWXD2QRpcFJ1gaKY+4dI9wBOfqLikpgddmNFhKu6p8pIIMCx2DhFeZ2wIAc\nFySFskIrRPSGWrA+JmcRQ9wt1RYf5gzxg6yPuwpLAlFGQgVOQFU/5A/8FX7d\nYq8LcaeRVzyb10nMXF5K/N7mWo6Qxi+BR1WvyWKVd0g+Y0gj664MKjxGAaw4\nb5zXuUMfYR0yyI1vN/g+fgrJJ3Ok8JVoc6+WwpEkILzeGg4hT8jepbPpqVK4\nldiYpGdCo2OiGZiZ/Xnl/Ewp9VUlvmVdve5tkU+T0pBk6rwIPrP+CAGyiSy8\nipY1fHWWa3/CZy2HupSWlgNuSDzSI3816cVr7mOnfeeyUrQUIVctm0QoYjSd\n7dn0\r\n=9ZFH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHvk9RzOyMDYeRq54HdbRogH5r4eT3ypeyib3ttn5FwKAiEApK+OJPff9TZkPPe+4WlLrgQ8i29IT2JFgibB+2OHT+Y="}]},"maintainers":[{"name":"kayandra","email":"tag@kayandra.co"},{"name":"apilayer-p","email":"support@apilayer.com"}],"_npmUser":{"name":"kayandra","email":"tag@kayandra.co"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/userstack_0.1.6_1569927842906_0.951021194189239"},"_hasShrinkwrap":false}},"time":{"created":"2019-10-01T11:04:02.539Z","0.1.6":"2019-10-01T11:04:03.036Z","modified":"2022-04-04T14:37:51.197Z"},"maintainers":[{"name":"kayandra","email":"tag@kayandra.co"},{"name":"apilayer-p","email":"support@apilayer.com"}],"description":"Userstack provides an API to Detect any Browser, Device & OS in Real-Time","author":{"name":"Samuel Oloruntoba","email":"github@kayandra.co","url":"https://kayandra.co"},"license":"MIT","readme":"# userstack-js\n\nUserstack provides an API to Detect any Browser, Device & OS in Real-Time\n\n## Installation\n\nUsing npm\n\n```\nnpm install --save @apilayer/userstack\n```\n\nor yarn\n\n```\nyarn add @apilayer/userstack\n```\n\n## Getting Started\n\nHead over to [Userstack](https://userstack.com/) and\ncreate an account. Copy access key from dashboard.\n\n```javascript\nimport userstack from '@apilayer/userstack'\n\nconst useHTTPs = false\nconst layer = new userstack(\"\", useHTTPs)\n```\n\n## `detect`\n\n`detect` Look up any given User-Agent string.\n\n**Signature:**\n\n```typescript\ndetect(ua: string): Promise\n```\n\n**Example:**\n\n```javascript\nconst response = layer.detect(\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\")\n\nconsole.log('response:', response)\n```\n\n**Response:**\n\n```javascript\n{\n ua: \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\",\n type: \"browser\",\n brand: \"Apple\",\n name: \"Mac\",\n url: \"https://www.google.com/about/company/\",\n os: {\n name: \"macOS 10.14 Mojave\",\n code: \"macos_10_14\",\n url: \"https://en.wikipedia.org/wiki/MacOS_Mojave\",\n family: \"macOS\",\n family_code: \"macos\",\n family_vendor: \"Apple Inc.\",\n icon: \"https://assets.userstack.com/icons/os/macosx.png\",\n icon_large: \"https://assets.userstack.com/icons/os/macosx_big.png\"\n },\n device: {\n is_mobile_device: false,\n type: \"desktop\",\n brand: \"Apple\",\n brand_code: \"apple\",\n brand_url: \"http://www.apple.com/\",\n name: \"Mac\"\n },\n browser: {\n name: \"Chrome\",\n version: \"71.0.3578.98\",\n version_major: \"71\",\n engine: \"WebKit/Blink\"\n },\n crawler: {\n is_crawler: false,\n category: null,\n last_seen: null\n }\n}\n```\n\n## `BulkDetect`\n\n`BulkDetect` Look up multiple User-Agent strings in bulk.\n\n**Signature:**\n\n```typescript\nbulkDetect(ua_batch: string[]): Promise\n```\n\n**Example:**\n\n```javascript\nconst response = layer.bulkDetect([\n \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\",\n])\n\nconsole.log('response:', response)\n```\n\n**Response:**\n\n```javascript\n[{\n ua: \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36\",\n type: \"browser\",\n brand: \"Apple\",\n name: \"Mac\",\n url: \"https://www.google.com/about/company/\",\n os: {\n name: \"macOS 10.14 Mojave\",\n code: \"macos_10_14\",\n url: \"https://en.wikipedia.org/wiki/MacOS_Mojave\",\n family: \"macOS\",\n family_code: \"macos\",\n family_vendor: \"Apple Inc.\",\n icon: \"https://assets.userstack.com/icons/os/macosx.png\",\n icon_large: \"https://assets.userstack.com/icons/os/macosx_big.png\"\n },\n device: {\n is_mobile_device: false,\n type: \"desktop\",\n brand: \"Apple\",\n brand_code: \"apple\",\n brand_url: \"http://www.apple.com/\",\n name: \"Mac\"\n },\n browser: {\n name: \"Chrome\",\n version: \"71.0.3578.98\",\n version_major: \"71\",\n engine: \"WebKit/Blink\"\n },\n crawler: {\n is_crawler: false,\n category: null,\n last_seen: null\n }\n}]\n```\n\n## License\n\n[MIT](/LICENSE)\n","readmeFilename":"README.md"}