Installation

npm install --save @types/dogapi

Summary

This package contains type definitions for dogapi (https://github.com/brettlangdon/node-dogapi#readme).

Details

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

index.d.ts

1export function initialize(opts: { api_key: string; app_key: string; api_host?: string | undefined }): void;
2
3interface event {
4    create(title: string, text: string, callback: (err: Error | null, res: EventCreateResponse) => void): void;
5    create(
6        title: string,
7        text: string,
8        properties: {
9            date_happened?: number | undefined;
10            priority?: "normal" | "low" | undefined;
11            host?: string | undefined;
12            tags?: readonly string[] | undefined;
13            alert_type?: "error" | "warning" | "info" | "success" | undefined;
14            aggregation_key?: string | undefined;
15            source_type_name?:
16                | "nagios"
17                | "hudson"
18                | "jenkins"
19                | "user"
20                | "my apps"
21                | "feed"
22                | "chef"
23                | "puppet"
24                | "git"
25                | "bitbucket"
26                | "fabric"
27                | "capistrano"
28                | undefined;
29        },
30        callback: (err: Error | null, res: EventCreateResponse) => void,
31    ): void;
32}
33
34export const event: event;
35
36interface metric {
37    send(metric: string, points: number | number[], callback: (err: Error | null, res: "ok") => void): void;
38    send(
39        metric: string,
40        points: number | number[],
41        extra: {
42            type?: "gauge" | "rate" | "count" | undefined;
43            metric_type?: "gauge" | "count" | undefined;
44            host?: string | undefined;
45            tags?: readonly string[] | undefined;
46        },
47        callback: (err: Error | null, res: "ok") => void,
48    ): void;
49    send_all(
50        metrics: Array<{
51            metric: string;
52            points: number | number[] | Array<[string, number]>;
53            tags?: string[] | undefined;
54            type?: string | undefined;
55            metric_type?: string | undefined;
56        }>,
57        callback: (err: Error | null, res: EventCreateResponse) => void,
58    ): void;
59}
60
61export const metric: metric;
62
63export interface EventCreateResponse {
64    ok: boolean;
65    event: {
66        date_happened: number;
67        handle: any;
68        id: bigint;
69        priority: "normal" | "low";
70        related_event_id: number | null;
71        tags: readonly string[];
72        text: string;
73        title: string;
74        url: string;
75    };
76    status: "ok";
77}
78
79export {};
80

Additional Details

• Last updated: Mon, 20 Nov 2023 23:36:24 GMT
• Dependencies: none

Credits

These definitions were written by olebedev.