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 { AdoptionCandidate } from '@crawlee/fs-storage-native';
import type * as storage from '@crawlee/types';

export { AdoptionCandidate }

// @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>;
    getStorageBackendCacheKey(): string;
    protected keyValueStoreAdoptionCandidates(_options: KeyValueStoreHookOptions): AdoptionCandidate[];
    purge(): Promise<void>;
    protected purgeKeyValueStore(store: PurgeableKeyValueStoreBackend, _options: KeyValueStoreHookOptions): Promise<void>;
    // (undocumented)
    storageExists(id: string, type: 'Dataset' | 'KeyValueStore' | 'RequestQueue'): Promise<boolean>;
    teardown(): Promise<void>;
}

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

// @public
export interface KeyValueStoreHookOptions {
    isDefaultStore: boolean;
}

// @public
export interface PurgeableKeyValueStoreBackend extends storage.KeyValueStoreBackend {
    purgeExcept(keys: string[]): Promise<void>;
}

// (No @packageDocumentation comment for this package)