@spider-cloud/spider-client 0.1.27 → 0.1.29

package/dist/client.d.ts

@@ -59,10 +59,12 @@ export declare class Spider {
     /**
      * Retrieves all links from the specified URL.
      * @param {string} url - The URL from which to gather links.
-     * @param {object} [params={}] - Additional parameters for the request.
-     * @returns {Promise<any>} A list of links extracted from the URL.
+     * @param {GenericParams} [params={}] - Additional parameters for the crawl.
+     * @param {boolean} [stream=false] - Whether to receive the response as a stream.
+     * @param {function} [callback=function] - The callback function when streaming per chunk. If this is set with stream you will not get a end response.
+     * @returns {Promise<any | Response>} The result of the crawl, either structured data or a Response object if streaming.
      */
-    links(url: string, params?: {}): Promise<any>;
+    links(url: string, params?: GenericParams, stream?: boolean, cb?: ChunkCallbackFunction): Promise<SpiderCoreResponse[] | void>;
     /**
      * Takes a screenshot of the website starting from this URL.
      * @param {string} url - The URL to start the screenshot.

package/dist/client.js

@@ -106,7 +106,7 @@ class Spider {
      */
     async crawlUrl(url, params = {}, stream = false, cb) {
         const jsonl = stream && cb;
-        const res = await this._apiPost(config_1.APIRoutes.Crawl, { url: url, ...params }, stream, !!jsonl);
+        const res = await this._apiPost(config_1.APIRoutes.Crawl, { url, ...params }, stream, !!jsonl);
         if (jsonl) {
             return await (0, stream_reader_1.streamReader)(res, cb);
         }
@@ -115,11 +115,18 @@ class Spider {
     /**
      * Retrieves all links from the specified URL.
      * @param {string} url - The URL from which to gather links.
-     * @param {object} [params={}] - Additional parameters for the request.
-     * @returns {Promise<any>} A list of links extracted from the URL.
+     * @param {GenericParams} [params={}] - Additional parameters for the crawl.
+     * @param {boolean} [stream=false] - Whether to receive the response as a stream.
+     * @param {function} [callback=function] - The callback function when streaming per chunk. If this is set with stream you will not get a end response.
+     * @returns {Promise<any | Response>} The result of the crawl, either structured data or a Response object if streaming.
      */
-    async links(url, params = {}) {
-        return this._apiPost(config_1.APIRoutes.Links, { url: url, ...params });
+    async links(url, params = {}, stream = false, cb) {
+        const jsonl = stream && cb;
+        const res = await this._apiPost(config_1.APIRoutes.Links, { url, ...params }, stream, !!jsonl);
+        if (jsonl) {
+            return await (0, stream_reader_1.streamReader)(res, cb);
+        }
+        return res;
     }
     /**
      * Takes a screenshot of the website starting from this URL.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spider-cloud/spider-client",
-  "version": "0.1.27",
+  "version": "0.1.29",
   "description": "Isomorphic Javascript SDK for Spider Cloud services",
   "scripts": {
     "test": "node --import tsx  --test __tests__/*test.ts",