@8ms/helpers 1.2.4 → 1.2.5

package/package.json

@@ -1,7 +1,7 @@
 {
     "name":            "@8ms/helpers",
     "license":         "UNLICENSED",
-    "version":         "1.2.4",
+    "version":         "1.2.5",
     "repository":      {
         "type": "git",
         "url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"

package/url/saveUrlContents.d.ts

@@ -0,0 +1,12 @@
+type SaveUrlContents = {
+    fileName: string;
+    path?: string;
+    url: string;
+};
+/**
+ * Downloads a given URL's contents to a local file.
+ *
+ * Requires fs-extra
+ */
+declare const saveUrlContents: ({ fileName, path, url }: SaveUrlContents) => Promise<unknown>;
+export default saveUrlContents;

package/url/saveUrlContents.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+/**
+ * Downloads a given URL's contents to a local file.
+ *
+ * Requires fs-extra
+ */
+const saveUrlContents = ({ fileName, path, url }) => {
+    const fs = require('fs-extra');
+    let finalPath = path ? path : '/tmp';
+    // Must begin with slash
+    if ('/' !== finalPath[0]) {
+        finalPath = '/' + finalPath;
+    }
+    // Must end without slash
+    if ('/' === finalPath[finalPath.length - 1]) {
+        finalPath = finalPath.substring(0, finalPath.length - 2);
+    }
+    return new Promise(async (resolve, reject) => {
+        (0, axios_1.default)({
+            method: "get",
+            url,
+            responseType: "stream"
+        })
+            .then(function (response) {
+            response.data.pipe(fs.createWriteStream(`${finalPath}/${fileName}`));
+            resolve(true);
+        });
+    });
+};
+exports.default = saveUrlContents;