chen-crawler/dist/storage.d.ts

Web Crawler Provider for Chen Framework

import { RedisConfig } from 'chen-redis';
/**
 * StorageConfig interface
 */
export interface StorageConfig extends RedisConfig {
    prefix?: string;
}
/**
 * Storage class
 */
export declare class Storage {
    /**
     * Connection
     * @type {RedisConnection}
     */
    private conn;
    /**
     * [prefix description]
     * @type {string}
     */
    private prefix;
    /**
     * Storage constructor
     * @param {string} private prefix
     * @param {RedisConfig} config
     */
    constructor(config: StorageConfig);
    /**
     * Get all
     * @param  {string} key
     * @return {Promise<string[]>}
     */
    all(key: string): Promise<string[]>;
    /**
     * Append to queue
     * @param  {string | number} key
     * @param  {string} url
     * @return {Promise<number>}
     */
    push(key: string | number, url: string): Promise<number>;
    /**
     * Check if url exists
     * @param  {string | number} key
     * @param  {string} url
     * @return {Promise<boolean>}
     */
    has(key: string | number, url: string): Promise<boolean>;
    /**
     * Pop from queue
     * @param  {string | number} key
     * @return {Promise<string>}
     */
    shift(key: string | number): Promise<string>;
    /**
     * Remove a value
     * @param  {string | number} key
     * @param  {string | number} value
     * @return {Promise<number>}
     */
    remove(key: string | number, url: string): Promise<number>;
    /**
     * Remove all queue
     * @return {Promise<string>}
    */
    flush(): Promise<string>;
}