apify-client 3.0.0-beta.62 → 3.0.0-beta.63

package/dist/resource_clients/dataset.d.ts

@@ -1,3 +1,4 @@
+import type { Readable } from 'node:stream';
 import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceClient } from '../base/resource_client.js';
@@ -167,6 +168,34 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
      * ```
      */
     downloadItems(format: `${DownloadItemsFormat}`, options?: DatasetClientDownloadItemsOptions): Promise<Buffer>;
+    /**
+     * Downloads dataset items in a specific format as a Readable stream. Only works in Node.js.
+     *
+     * Takes the same arguments as {@link downloadItems}, but resolves to the response body as a stream, so a large
+     * export is processed in chunks without holding all of it in memory.
+     *
+     * The stream holds its connection open until you consume it to the end or destroy it. Iterating it with
+     * `for await` or passing it to `pipeline()` from `node:stream/promises` does either one for you.
+     *
+     * @param format - Output format: `'json'`, `'jsonl'`, `'csv'`, `'xlsx'`, `'xml'`, `'rss'`, or `'html'`
+     * @param options - Download and formatting options, the same as for {@link downloadItems}
+     * @param options.timeoutSecs - Timeout for the API to start responding. Default is `'long'`. Once the stream is
+     * returned, it only limits inactivity: the stream errors if no data arrives for that long. To stop the download
+     * early or cap its total duration, destroy the stream or abort `signal`.
+     * @returns Readable stream of the items serialized to the specified format
+     * @see https://docs.apify.com/api/v2/dataset-items-get
+     *
+     * @example
+     * ```javascript
+     * const { createWriteStream } = require('node:fs');
+     * const { pipeline } = require('node:stream/promises');
+     *
+     * // Write a CSV export straight to a file
+     * const stream = await client.dataset('my-dataset').streamItems('csv', { bom: true });
+     * await pipeline(stream, createWriteStream('output.csv'));
+     * ```
+     */
+    streamItems(format: `${DownloadItemsFormat}`, options?: DatasetClientDownloadItemsOptions): Promise<Readable>;
     /**
      * Stores one or more items into the dataset.
      *

package/dist/resource_clients/dataset.js

@@ -3,6 +3,7 @@ import { createStorageContentSignatureAsync } from '@apify/utilities';
 import { ResourceClient } from '../base/resource_client.js';
 import * as schemas from '../schemas.js';
 import { timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
+import { runtime } from '#runtime';
 import { anyObjectSchema, applyQueryParamsToUrl, cast, isNonArrayObject, paginationOptionsShape, parseArgument, parseResponse, SCANNED_COUNT, } from '../utils.js';
 /**
  * Supported formats for downloading dataset items.
@@ -269,6 +270,52 @@ export class DatasetClient extends ResourceClient {
         });
         return cast(data);
     }
+    /**
+     * Downloads dataset items in a specific format as a Readable stream. Only works in Node.js.
+     *
+     * Takes the same arguments as {@link downloadItems}, but resolves to the response body as a stream, so a large
+     * export is processed in chunks without holding all of it in memory.
+     *
+     * The stream holds its connection open until you consume it to the end or destroy it. Iterating it with
+     * `for await` or passing it to `pipeline()` from `node:stream/promises` does either one for you.
+     *
+     * @param format - Output format: `'json'`, `'jsonl'`, `'csv'`, `'xlsx'`, `'xml'`, `'rss'`, or `'html'`
+     * @param options - Download and formatting options, the same as for {@link downloadItems}
+     * @param options.timeoutSecs - Timeout for the API to start responding. Default is `'long'`. Once the stream is
+     * returned, it only limits inactivity: the stream errors if no data arrives for that long. To stop the download
+     * early or cap its total duration, destroy the stream or abort `signal`.
+     * @returns Readable stream of the items serialized to the specified format
+     * @see https://docs.apify.com/api/v2/dataset-items-get
+     *
+     * @example
+     * ```javascript
+     * const { createWriteStream } = require('node:fs');
+     * const { pipeline } = require('node:stream/promises');
+     *
+     * // Write a CSV export straight to a file
+     * const stream = await client.dataset('my-dataset').streamItems('csv', { bom: true });
+     * await pipeline(stream, createWriteStream('output.csv'));
+     * ```
+     */
+    async streamItems(format, options = {}) {
+        parseArgument(format, itemFormatSchema);
+        const { timeoutSecs = 'long', signal, ...query } = parseArgument(options, downloadItemsOptionsSchema, 'DatasetClientDownloadItemsOptions');
+        if (!runtime.isNode) {
+            throw new Error('The streamItems() method can only be used in Node.js environment.');
+        }
+        const { data } = await this.httpClient.call({
+            url: this.buildUrl('items'),
+            method: 'GET',
+            params: this.buildParams({
+                format,
+                ...query,
+            }),
+            responseType: 'stream',
+            timeoutSecs,
+            signal,
+        });
+        return cast(data);
+    }
     /**
      * Stores one or more items into the dataset.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "3.0.0-beta.62",
+  "version": "3.0.0-beta.63",
   "description": "Apify API client for JavaScript",
   "engines": {
     "node": ">=22.13.0"