Merge pull request #15 from ConnerTechnology/release-2.1.0

Release 2.1.0

Author: thomasconner

.eslintrc.js

@@ -31,7 +31,10 @@ module.exports = {
       },
       env: {
         jest: true
-      }
+      },
+      parserOptions: {
+        project: path.resolve(__dirname, './tsconfig.test.json')
+      },
     }
   ],
   settings: {

.github/workflows/main.yml

@@ -25,6 +25,8 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Test
+        env:
+          IPDATA_API_KEY: ${{ secrets.IPDATA_API_KEY }}
         run: npm test
 
   release:

README.md

@@ -1,16 +1,16 @@
 # IPData JavaScript Library
 
-![](https://github.com/ConnerTechnology/ipdata-js-library/workflows/CI/badge.svg)
+[![CI Status](https://github.com/ConnerTechnology/ipdata-js-library/workflows/.github/workflows/main.yml/badge.svg)](https://github.com/ConnerTechnology/ipdata-js-library/actions)
 
 JavaScript library that can be used in a web browser or Node.js application to gather information using https://ipdata.co.
 
 **Table of Contents**
+
 - [Install](#install)
 - [Import the library](#import-the-library)
 - [Use](#use)
-  * [Lookup](#lookup)
-  * [Lookup Bulk](#lookup-bulk)
-
+  - [Lookup](#lookup)
+  - [Lookup Bulk](#lookup-bulk)
 
 ## Install
 
@@ -32,76 +32,83 @@ Create an instance of the `IPData` class and pass your api key for IPData as the
 const ipdata = new IPData('<apiKey>');
 ```
 
-The library will cache responses using the `lookup()` method for 24 hours using a LRU cache. You can turn off the cache by passing `false` as the second parameter to the constructor.
+The library will cache 4096 ip addresses responses for 24 hours using a LRU cache by default. You can configure the cache by passing an object as the second paramenter.
+
+```js
+const cacheConfig = {
+  max: 1000, // max size
+  maxAge: 10 * 60 * 1000, // max age in ms (i.e. 10 minutes)
+};
+const ipdata = new IPData('<apiKey>', cacheConfig);
+```
+
+**Note:** To disable the cache pass `-1` as the `maxAge`.
 
 ```js
-const ipdata = new IPData('<apiKey>', false);
+const cacheConfig = {
+  maxAge: -1, // disable the cache
+};
+const ipdata = new IPData('<apiKey>', cacheConfig);
 ```
 
 ### Lookup
 
 The library will lookup the ip address of the host computer if no ip address is provided.
 
 ```js
-ipdata.lookup()
-  .then(function(info) {
-    // info.ip === '<hostcomputerip>'
-    // ...
-  });
+ipdata.lookup().then(function(info) {
+  // info.ip === '<hostcomputerip>'
+  // ...
+});
 ```
 
 You can pass an ip address as the first parameter to the `lookup()` method to lookup information about the ip address using IPData.
 
 ```js
-ipdata.lookup('1.1.1.1')
-  .then(function(info) {
-    // info.ip === 1.1.1.1
-    // ...
-  });
+ipdata.lookup('1.1.1.1').then(function(info) {
+  // info.ip === 1.1.1.1
+  // ...
+});
 ```
 
 You can specify only a select field to be returned when looking up an ip address by passing a field as the second parameter to the `lookup()` method.
 
 ```js
 const ip = '1.1.1.1';
-const selectField = 'ip'
-ipdata.lookup(ip, selectField)
-  .then(function(info) {
-    // info.select_field === 1.1.1.1
-    // ...
-  });
+const selectField = 'ip';
+ipdata.lookup(ip, selectField).then(function(info) {
+  // info.select_field === 1.1.1.1
+  // ...
+});
 ```
 
 You can specify only certain fields to be returned when looking up an ip address by passing an array of fields as the third parameter to the `lookup()` method.
 
 ```js
 const ip = '1.1.1.1';
 const fields = ['ip', 'city'];
-ipdata.lookup(ip, null, fields)
-  .then(function(info) {
-    // ...
-  });
+ipdata.lookup(ip, null, fields).then(function(info) {
+  // ...
+});
 ```
 
 ### Bulk Lookup
 
 You can lookup multiple ip addresses with one API call using the `bulkLookup()` method.
 
 ```js
-ipdata.bulkLookup(['1.1.1.1', '1.0.0.1'])
-  .then(function(info) {
-    // info.responses[0].ip === 1.1.1.1
-    // ...
-  });
+ipdata.bulkLookup(['1.1.1.1', '1.0.0.1']).then(function(info) {
+  // info.responses[0].ip === 1.1.1.1
+  // ...
+});
 ```
 
 You can specify only certain fields to be returned when looking up multiple ip addresses by passing an array of fields as the second parameter to the `bulkLookup()` method.
 
 ```js
 const ips = ['1.1.1.1', '1.0.0.1'];
 const fields = ['ip', 'city'];
-ipdata.bulkLookup(ips, fields)
-  .then(function(info) {
-    // ...
-  });
+ipdata.bulkLookup(ips, fields).then(function(info) {
+  // ...
+});
 ```

package-lock.json

@@ -1,13 +1,13 @@
 {
   "name": "ipdata",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "JavaScript library to gather information for an ip using https://ipdata.co.",
-  "main": "./lib/index.js",
+  "main": "./lib/ipdata.js",
   "scripts": {
     "prebuild": "del lib",
     "build": "tsc",
     "lint": "eslint --fix \"src/**\"",
-    "test": "jest"
+    "test": "dotenv jest"
   },
   "repository": {
     "type": "git",
@@ -24,7 +24,7 @@
     "is-ip": "^3.1.0",
     "lodash": "4.17.15",
     "lru-cache": "5.1.1",
-    "tslib": "1.9.3",
+    "tslib": "1.10.0",
     "url-join": "4.0.0"
   },
   "devDependencies": {
@@ -37,6 +37,7 @@
     "@typescript-eslint/eslint-plugin": "^2.4.0",
     "@typescript-eslint/parser": "^2.4.0",
     "del-cli": "^3.0.0",
+    "dotenv-cli": "3.0.0",
     "eslint": "^6.5.1",
     "eslint-config-airbnb-base": "^14.0.0",
     "eslint-config-prettier": "^6.4.0",