@types/x-ray

Installation

npm install --save @types/x-ray

Summary

This package contains type definitions for x-ray (https://github.com/lapwinglabs/x-ray#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/x-ray.

index.d.ts

/// <reference types="node" />

import Bluebird = require("bluebird");
import XRayCrawler = require("x-ray-crawler");

export = XRay;

declare function XRay(options?: XRay.Options): XRay.Instance;

declare namespace XRay {
    type Filter = (value: any, ...args: string[]) => any;
    interface Options {
        filters: { [key: string]: Filter };
    }
    type Callback = (err: Error, data: any) => void;

    // circularly references itself
    // https://stackoverflow.com/a/41826582
    type ScalarSelector =
        | string
        | InstanceInvocation
        | { [key: string]: Selector };
    interface SelectorArray extends Array<ScalarSelector | SelectorArray> {
        [index: number]: ScalarSelector | SelectorArray;
    }
    type Selector = ScalarSelector | SelectorArray;

    type AbortHandler = (data: unknown[], url: string) => boolean;

    interface Instance extends XRayCrawler.Instance {
        (
            source: string,
            selector: Selector,
        ): InstanceInvocation;
        (
            source: string,
            context: string,
            selector: Selector,
        ): InstanceInvocation;
        (
            context: string,
            selector: Selector,
        ): InstanceInvocation;
        (
            selector: Selector,
        ): InstanceInvocation;
    }

    interface InstanceInvocation {
        (callback: Callback): void;
        (source: string, callback: Callback): void;
        abort(arg: AbortHandler): this;
        paginate(selector: Selector): this;
        limit(n: number): this;
        stream(): NodeJS.ReadStream;
        then<U>(fn?: (value: any) => U | PromiseLike<U>): Bluebird<U>;
        write(path?: string): (err: NodeJS.ErrnoException) => void;
    }
}

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: @types/bluebird, @types/node, @types/x-ray-crawler

Credits

These definitions were written by Matt Traynham.