crawlee-fs-storage.api

Public API Report File for "@crawlee/fs-storage"

Do not edit this file. It is a report generated by API Extractor.

import type { CrawleeLogger } from '@crawlee/types';
import type * as storage from '@crawlee/types';

// @public
export class FileSystemStorageBackend implements storage.StorageBackend {
    constructor(options: FileSystemStorageOptions);
    // (undocumented)
    createDatasetBackend(options?: storage.StorageIdentifier): Promise<storage.DatasetBackend>;
    // (undocumented)
    createKeyValueStoreBackend(options?: storage.StorageIdentifier): Promise<storage.KeyValueStoreBackend>;
    // (undocumented)
    createRequestQueueBackend(options?: storage.StorageIdentifier): Promise<storage.RequestQueueBackend>;
    // (undocumented)
    readonly datasetsDirectory: string;
    getStorageBackendCacheKey(): string;
    // (undocumented)
    readonly keyValueStoresDirectory: string;
    // (undocumented)
    readonly localDataDirectory: string;
    // (undocumented)
    readonly logger?: CrawleeLogger;
    purge(): Promise<void>;
    // (undocumented)
    readonly requestQueueAccess: 'single' | 'shared';
    // (undocumented)
    readonly requestQueuesDirectory: string;
    // (undocumented)
    storageExists(id: string, type: 'Dataset' | 'KeyValueStore' | 'RequestQueue'): Promise<boolean>;
    teardown(): Promise<void>;
}

// @public (undocumented)
export interface FileSystemStorageOptions {
    localDataDirectory: string;
    logger?: CrawleeLogger;
    requestQueueAccess?: 'single' | 'shared';
}

// (No @packageDocumentation comment for this package)