Installation

npm install --save @types/oboe

Summary

This package contains type definitions for oboe (https://github.com/jimhigson/oboe.js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/oboe.

index.d.ts

1/// <reference types="node" />
2
3declare namespace oboe {
4    interface OboeFunction extends Function {
5        drop: Object;
6        (url: string): Oboe; // simple fetch the url
7        (options: Options): Oboe; // fetch with full parameters
8        (stream: NodeJS.ReadableStream): Oboe; // read data from the given Node stream
9        (): Oboe; // parse data given by the emit() calls
10    }
11
12    interface Oboe {
13        done(callback: (result: any) => void): Oboe;
14
15        fail(callback: (result: FailReason) => void): Oboe;
16
17        node(pattern: string, callback: CallbackSignature): Oboe;
18        node(patterns: PatternMap): Oboe;
19
20        on(event: string, pattern: string, callback: CallbackSignature): Oboe;
21        on(eventPattern: string, callback: CallbackSignature): Oboe;
22
23        path(pattern: string, callback: CallbackSignature): Oboe;
24        path(listeners: any): Oboe;
25
26        removeListener(eventPattern: string, callback: CallbackSignature): Oboe;
27        removeListener(event: string, pattern: string, callback: CallbackSignature): Oboe;
28
29        start(callback: (status: number, headers: Object) => void): Oboe;
30
31        abort(): void;
32
33        emit(message: "data" | "end", data?: string): void;
34
35        source: string;
36    }
37
38    interface CallbackSignature {
39        (node: any, pathOrHeaders: any, ancestors: Object[]): any;
40    }
41
42    interface Options {
43        url: string;
44        method?: string | undefined;
45        headers?: Object | undefined;
46        body?: any;
47        cached?: boolean | undefined;
48        withCredentials?: boolean | undefined;
49    }
50
51    interface FailReason {
52        thrown?: Error | undefined;
53        statusCode?: number | undefined;
54        body?: string | undefined;
55        jsonBody?: Object | undefined;
56    }
57
58    interface PatternMap {
59        [pattern: string]: CallbackSignature;
60    }
61}
62
63declare var oboe: oboe.OboeFunction;
64
65export = oboe;
66export as namespace oboe;
67

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/node

Credits

These definitions were written by Jared Klopper.