conversiontools - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "conversiontools",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "JavaScript library to convert files using Conversion Tools API at https://conversiontools.io",
@@ -30,7 +30,7 @@ "keywords": [
   "dependencies": {
-    "form-data": "^3.0.0",
-    "node-fetch": "^2.6.0"
+    "form-data": "^4.0.0",
+    "node-fetch": "^2.6.1"
   },
   "devDependencies": {
-    "eslint": "^6.8.0"
+    "eslint": "^7.26.0"
   },
@@ -37,0 +37,0 @@ "engines": {

README.md

@@ -23,2 +23,4 @@ # [Conversion Tools](https://conversiontools.io) API Node.js Client
 
+### Using Promises
+
 ```javascript
@@ -30,6 +32,33 @@ const ConversionClient = require('conversiontools');
 
-const conversion = new ConversionClient(apiToken);
+const conversionClient = new ConversionClient(apiToken);
+const conversionOptions = {
+  filename: 'test.xml',
+  timeout: 4000,
+  outputFilename: 'test.xml.csv',
+  options: {
+    delimiter: 'tab',
+  },
+};
 
-conversion
-  .run('convert.xml_to_csv', {
+conversionClient
+  .run('convert.xml_to_csv', conversionOptions)
+  .then((filename) => {
+    console.log('File downloaded to', filename);
+  })
+  .catch(err => {
+    console.error('Conversion error', err);
+  });
+```
+
+### Using async/await
+
+```javascript
+const ConversionClient = require('conversiontools');
+
+// API Token from your Profile page at https://conversiontools.io/profile
+const apiToken = 'put the api token here';
+
+const convert = async () => {
+  const conversionClient = new ConversionClient(apiToken);
+  const conversionOptions = {
     filename: 'test.xml',
@@ -41,11 +70,46 @@ timeout: 4000,
     },
-  })
-  .then((filename) => {
+  };
+  try {
+    const filename = await conversionClient.run('convert.xml_to_csv', conversionOptions);
     console.log('File downloaded to', filename);
-  })
-  .catch(err => {
-    console.log('Conversion error', err);
-  });
+  } catch (err) {
+    console.error('Conversion error', err);
+  }
+};
+
+convert();
 ```
 
+### Conversion with URL
+
+The following example saving website page provided by the URL to JPG image.
+
+```javascript
+const ConversionClient = require('conversiontools');
+
+// API Token from your Profile page at https://conversiontools.io/profile
+const apiToken = 'put the api token here';
+
+const convert = async () => {
+  const conversionClient = new ConversionClient(apiToken);
+  const conversionOptions = {
+    url: 'https://en.wikipedia.org/wiki/Main_Page',
+    timeout: 4000,
+    outputFilename: 'wiki.jpg',
+    options: {
+      images: 'yes',
+      javascript: 'yes',
+    },
+  };
+  try {
+    const filename = await conversionClient.run('convert.website_to_jpg', conversionOptions);
+    console.log('File downloaded to', filename);
+  } catch (err) {
+    console.error('Conversion error', err);
+  }
+};
+
+convert();
+```
+
 ## Documentation
@@ -59,2 +123,2 @@
 
-Copyright (c) 2020 [Conversion Tools](https://conversiontools.io)
+Copyright (c) 2020-2021 [Conversion Tools](https://conversiontools.io)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11508

increased by15.96%

Number of lines in readme file

121

increased by112.28%

Dependency changes

• + Addedform-data@4.0.0(transitive)

• - Removedform-data@3.0.1(transitive)

• Updatedform-data@^4.0.0

• Updatednode-fetch@^2.6.1