apify 2.3.1-beta.4 → 3.0.0-alpha.0

package/build/storages/key_value_store.d.ts

@@ -1,243 +0,0 @@
-export function maybeStringify(value: any, options: any): any;
-/**
- * The `KeyValueStore` class represents a key-value store, a simple data storage that is used
- * for saving and reading data records or files. Each data record is
- * represented by a unique key and associated with a MIME content type. Key-value stores are ideal
- * for saving screenshots, actor inputs and outputs, web pages, PDFs or to persist the state of crawlers.
- *
- * Do not instantiate this class directly, use the
- * {@link Apify#openKeyValueStore} function instead.
- *
- * Each actor run is associated with a default key-value store, which is created exclusively
- * for the run. By convention, the actor input and output are stored into the
- * default key-value store under the `INPUT` and `OUTPUT` key, respectively.
- * Typically, input and output are JSON files, although it can be any other format.
- * To access the default key-value store directly, you can use the
- * {@link Apify#getValue} and {@link Apify#setValue} convenience functions.
- *
- * To access the input, you can also use the {@link Apify#getInput} convenience function.
- *
- * `KeyValueStore` stores its data either on local disk or in the Apify cloud,
- * depending on whether the [`APIFY_LOCAL_STORAGE_DIR`](../guides/environment-variables#apify_local_storage_dir)
- * or [`APIFY_TOKEN`](../guides/environment-variables#apify_token) environment variables are set.
- *
- * If the `APIFY_LOCAL_STORAGE_DIR` environment variable is set, the data is stored in
- * the local directory in the following files:
- * ```
- * {APIFY_LOCAL_STORAGE_DIR}/key_value_stores/{STORE_ID}/{INDEX}.{EXT}
- * ```
- * Note that `{STORE_ID}` is the name or ID of the key-value store. The default key-value store has ID: `default`,
- * unless you override it by setting the `APIFY_DEFAULT_KEY_VALUE_STORE_ID` environment variable.
- * The `{KEY}` is the key of the record and `{EXT}` corresponds to the MIME content type of the data value.
- *
- * If the [`APIFY_TOKEN`](../guides/environment-variables#apify_token) environment variable is set but
- * [`APIFY_LOCAL_STORAGE_DIR`](../guides/environment-variables#apify_local_storage_dir) not,
- * the data is stored in the [Apify Key-value store](https://docs.apify.com/storage/key-value-store)
- * cloud storage. Note that you can force usage of the cloud storage also by passing the `forceCloud`
- * option to {@link Apify#openKeyValueStore} function, even if the
- * [`APIFY_LOCAL_STORAGE_DIR`](../guides/environment-variables#apify_local_storage_dir) variable is set.
- *
- * **Example usage:**
- *
- * ```javascript
- * // Get actor input from the default key-value store.
- * const input = await Apify.getInput();
- * // Get some value from the default key-value store.
- * const otherValue = await Apify.getValue('my-key');
- *
- * // Write actor output to the default key-value store.
- * await Apify.setValue('OUTPUT', { myResult: 123 });
- *
- * // Open a named key-value store
- * const store = await Apify.openKeyValueStore('some-name');
- *
- * // Write a record. JavaScript object is automatically converted to JSON,
- * // strings and binary buffers are stored as they are
- * await store.setValue('some-key', { foo: 'bar' });
- *
- * // Read a record. Note that JSON is automatically parsed to a JavaScript object,
- * // text data returned as a string and other data is returned as binary buffer
- * const value = await store.getValue('some-key');
- *
- *  // Drop (delete) the store
- * await store.drop();
- * ```
- * @hideconstructor
- */
-export class KeyValueStore {
-    /**
-     * @param {object} options
-     * @param {string} options.id
-     * @param {string} [options.name]
-     * @param {ApifyClient|ApifyStorageLocal} options.client
-     * @param {boolean} options.isLocal
-     * @param {Configuration} [config]
-     */
-    constructor(options: {
-        id: string;
-        name?: string | undefined;
-        client: ApifyClient | ApifyStorageLocal;
-        isLocal: boolean;
-    }, config?: Configuration | undefined);
-    id: string;
-    name: string | undefined;
-    isLocal: boolean;
-    client: import("@apify/storage-local/dist/resource_clients/key_value_store").KeyValueStoreClient | import("apify-client").KeyValueStoreClient;
-    log: import("@apify/log/log").Log;
-    config: Configuration;
-    /**
-     * Gets a value from the key-value store.
-     *
-     * The function returns a `Promise` that resolves to the record value,
-     * whose JavaScript type depends on the MIME content type of the record.
-     * Records with the `application/json`
-     * content type are automatically parsed and returned as a JavaScript object.
-     * Similarly, records with `text/plain` content types are returned as a string.
-     * For all other content types, the value is returned as a raw
-     * [`Buffer`](https://nodejs.org/api/buffer.html) instance.
-     *
-     * If the record does not exist, the function resolves to `null`.
-     *
-     * To save or delete a value in the key-value store, use the
-     * {@link KeyValueStore#setValue} function.
-     *
-     * **Example usage:**
-     *
-     * ```javascript
-     * const store = await Apify.openKeyValueStore();
-     * const buffer = await store.getValue('screenshot1.png');
-     * ```
-     * @param {string} key
-     *   Unique key of the record. It can be at most 256 characters long and only consist
-     *   of the following characters: `a`-`z`, `A`-`Z`, `0`-`9` and `!-_.'()`
-     * @returns {Promise<KeyValueStoreValueTypes>}
-     *   Returns a promise that resolves to an object, string
-     *   or [`Buffer`](https://nodejs.org/api/buffer.html), depending
-     *   on the MIME content type of the record.
-     */
-    getValue(key: string): Promise<KeyValueStoreValueTypes>;
-    /**
-     * Saves or deletes a record in the key-value store.
-     * The function returns a promise that resolves once the record has been saved or deleted.
-     *
-     * **Example usage:**
-     *
-     * ```javascript
-     * const store = await Apify.openKeyValueStore();
-     * await store.setValue('OUTPUT', { foo: 'bar' });
-     * ```
-     *
-     * Beware that the key can be at most 256 characters long and only contain the following characters: `a-zA-Z0-9!-_.'()`
-     *
-     * By default, `value` is converted to JSON and stored with the
-     * `application/json; charset=utf-8` MIME content type.
-     * To store the value with another content type, pass it in the options as follows:
-     * ```javascript
-     * const store = await Apify.openKeyValueStore('my-text-store');
-     * await store.setValue('RESULTS', 'my text data', { contentType: 'text/plain' });
-     * ```
-     * If you set custom content type, `value` must be either a string or
-     * [`Buffer`](https://nodejs.org/api/buffer.html), otherwise an error will be thrown.
-     *
-     * If `value` is `null`, the record is deleted instead. Note that the `setValue()` function succeeds
-     * regardless whether the record existed or not.
-     *
-     * To retrieve a value from the key-value store, use the
-     * {@link KeyValueStore#getValue} function.
-     *
-     * **IMPORTANT:** Always make sure to use the `await` keyword when calling `setValue()`,
-     * otherwise the actor process might finish before the value is stored!
-     *
-     * @param {string} key
-     *   Unique key of the record. It can be at most 256 characters long and only consist
-     *   of the following characters: `a`-`z`, `A`-`Z`, `0`-`9` and `!-_.'()`
-     * @param {KeyValueStoreValueTypes} value
-     *   Record data, which can be one of the following values:
-     *    - If `null`, the record in the key-value store is deleted.
-     *    - If no `options.contentType` is specified, `value` can be any JavaScript object and it will be stringified to JSON.
-     *    - If `options.contentType` is set, `value` is taken as is and it must be a `String` or [`Buffer`](https://nodejs.org/api/buffer.html).
-     *   For any other value an error will be thrown.
-     * @param {object} [options]
-     * @param {string} [options.contentType]
-     *   Specifies a custom MIME content type of the record.
-     * @returns {Promise<void>}
-     *
-     */
-    setValue(key: string, value: KeyValueStoreValueTypes, options?: {
-        contentType?: string | undefined;
-    } | undefined): Promise<void>;
-    /**
-     * Removes the key-value store either from the Apify cloud storage or from the local directory,
-     * depending on the mode of operation.
-     *
-     * @return {Promise<void>}
-     */
-    drop(): Promise<void>;
-    /**
-     * Returns a URL for the given key that may be used to publicly
-     * access the value in the remote key-value store.
-     *
-     * @param {string} key
-     * @return {string}
-     */
-    getPublicUrl(key: string): string;
-    /**
-     * Iterates over key-value store keys, yielding each in turn to an `iteratee` function.
-     * Each invocation of `iteratee` is called with three arguments: `(key, index, info)`, where `key`
-     * is the record key, `index` is a zero-based index of the key in the current iteration
-     * (regardless of `options.exclusiveStartKey`) and `info` is an object that contains a single property `size`
-     * indicating size of the record in bytes.
-     *
-     * If the `iteratee` function returns a Promise then it is awaited before the next call.
-     * If it throws an error, the iteration is aborted and the `forEachKey` function throws the error.
-     *
-     * **Example usage**
-     * ```javascript
-     * const keyValueStore = await Apify.openKeyValueStore();
-     * await keyValueStore.forEachKey(async (key, index, info) => {
-     *   console.log(`Key at ${index}: ${key} has size ${info.size}`);
-     * });
-     * ```
-     *
-     * @param {KeyConsumer} iteratee A function that is called for every key in the key-value store.
-     * @param {object} [options] All `forEachKey()` parameters are passed
-     *   via an options object with the following keys:
-     * @param {string} [options.exclusiveStartKey] All keys up to this one (including) are skipped from the result.
-     * @return {Promise<void>}
-     */
-    forEachKey(iteratee: KeyConsumer, options?: {
-        exclusiveStartKey?: string | undefined;
-    } | undefined): Promise<void>;
-    /**
-     * @param {KeyConsumer} iteratee
-     * @param {Record<string, any>} [options]
-     * @param {number} [index=0]
-     * @return {Promise<Promise<void> | undefined>}
-     * @private
-     */
-    private _forEachKey;
-}
-export function openKeyValueStore(storeIdOrName?: string | undefined, options?: {
-    forceCloud?: boolean | undefined;
-    config?: Configuration | undefined;
-} | undefined): Promise<KeyValueStore>;
-export function getValue(key: string): Promise<{
-    [x: string]: any;
-} | string | Buffer | null>;
-export function setValue(key: string, value: any, options?: {
-    contentType?: string | undefined;
-} | undefined): Promise<void>;
-export function getInput(): Promise<{
-    [x: string]: any;
-} | string | Buffer | null>;
-export type KeyValueStoreValueTypes = ({
-    [x: string]: any;
-} | null | Buffer | string);
-/**
- * User-function used in the  {@link KeyValueStoreforEachKey } method.
- */
-export type KeyConsumer = (key: string, index: number, info: any, size: number) => any;
-import { Configuration } from "../configuration";
-import { ApifyClient } from "apify-client/dist/apify_client";
-import { ApifyStorageLocal } from "@apify/storage-local";
-//# sourceMappingURL=key_value_store.d.ts.map

package/build/storages/key_value_store.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"key_value_store.d.ts","sourceRoot":"","sources":["../../src/storages/key_value_store.js"],"names":[],"mappings":"AAwBO,8DAuBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH;IACI;;;;;;;OAOG;IACH;QAN2B,EAAE,EAAlB,MAAM;QACW,IAAI;QACkB,MAAM,EAA7C,WAAW,GAAC,iBAAiB;QACZ,OAAO,EAAxB,OAAO;2CAUjB;IANG,WAAoB;IACpB,yBAAwB;IACxB,iBAA8B;IAC9B,8IAAmD;IACnD,kCAAiD;IACjD,sBAAoB;IAGxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,cARW,MAAM,GAGJ,QAAQ,uBAAuB,CAAC,CAa5C;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,cAfW,MAAM,SAGN,uBAAuB;;oBASrB,QAAQ,IAAI,CAAC,CA+BzB;IAED;;;;;OAKG;IACH,QAFY,QAAQ,IAAI,CAAC,CAMxB;IAED;;;;;;OAMG;IACH,kBAHW,MAAM,GACL,MAAM,CAIjB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,qBANW,WAAW;;oBAIV,QAAQ,IAAI,CAAC,CAIxB;IAED;;;;;;OAMG;IACH,oBAeC;CACJ;AAwBM;;;gBALM,QAAQ,aAAa,CAAC,CAclC;AAiCM,8BAXI,MAAM,GAEJ,QAAQ;QAAO,MAAM;IAAK,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,CAazD;AAsCM,8BAhBI,MAAM;;gBAWL,QAAQ,IAAI,CAAC,CASxB;AAiCM,4BATM,QAAQ;QAAO,MAAM;IAAK,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,CASiD;sCApc9F,CAAC;QAAO,MAAM;IAAK,IAAI,GAAC,MAAM,GAAC,MAAM,CAAC;;;;gCAycxC,MAAM,SAEN,MAAM,mBAIN,MAAM"}