forked from JaylyDev/ScriptAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.d.ts
More file actions
90 lines (90 loc) · 2.23 KB
/
index.d.ts
File metadata and controls
90 lines (90 loc) · 2.23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
declare global {
var KEY: string;
}
export declare class RESTError extends Error {
}
interface RequestOptions {
[RequestMethod.DELETE]: {
request: {
key?: string;
};
response: void;
};
[RequestMethod.GET]: {
request: {
key: string;
};
response: string | number | boolean;
};
[RequestMethod.PUT]: {
request: {
key: string;
value: string | number | boolean;
};
response: void;
};
[RequestMethod.POST]: {
request: {};
response: void;
};
[RequestMethod.PATCH]: {
request: {
key: string;
value: string | number | boolean;
};
response: number | void;
};
}
type RequestOption<T extends keyof RequestOptions> = {
method: T;
} & RequestOptions[T]['request'];
export declare class Table {
readonly route: `/${string}`;
readonly data: Member[];
/**
* @internal
*/
toRawtext(): string;
constructor(rawtext: string);
}
export declare class Member {
key: string;
value: string | number | boolean;
constructor(key: string, value: string | number | boolean);
}
/**
* Request methods available with Rest API
*/
export declare enum RequestMethod {
/**
* POST requests are commonly used to create a new resource that is a
* subordinate of the specified route.
*/
POST = "POST",
/**
* GET requests are commonly used to retrieve information about a resource
* at the specified route.
*/
GET = "GET",
/**
* PUT requests are commonly used to update a single resource that already
* exists in a resource collection.
*/
PUT = "PUT",
/**
* PATCH requests are commonly used to update partial of an already
* existed resource collection.
*/
PATCH = "PATCH",
/**
* POST requests are commonly used to remove an existing resource that is a
* subordinate of the specified route.
*/
DELETE = "DELETE"
}
export declare class REST {
private readonly scoreboard;
constructor(id: string);
request<T extends keyof RequestOptions>(route: `/${string}`, options: RequestOption<T>): RequestOptions[T]["response"];
}
export {};