forked from Kong/httpsnippet
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.d.ts
More file actions
169 lines (150 loc) · 3.42 KB
/
index.d.ts
File metadata and controls
169 lines (150 loc) · 3.42 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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
// Type definitions for httpsnippet 1.23
// Project: https://github.com/Kong/httpsnippet
// Definitions by: Marcell Toth <https://github.com/marcelltoth>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// Copy and paste from https://github.com/DefinitelyTyped/DefinitelyTyped
// Just make a update for my personal project
import { Har, Request } from "har-format";
/*~ This declaration specifies that the class constructor function
*~ is the exported object from the file
*/
export = HTTPSnippet;
/*~ Write your module's methods and properties in this class */
declare class HTTPSnippet {
constructor(data: HTTPSnippet.Data);
convert(target: Languages, options?: HTTPSnippet.Options): string | false;
convert(
target: Languages,
client?: HttpClient,
options?: HTTPSnippet.Options
): string | false;
static addTarget(target: HTTPSnippet.Target): void;
static addTargetClient(
target: string,
client: HTTPSnippet.TargetClient
): void;
static availableTargets: string[];
static extName(target: string): string;
}
declare namespace HTTPSnippet {
type Data = Har | HttpSnippetRequest;
type Options = object;
interface TargetClientInfo {
key: string;
title: string;
link?: string;
description?: string;
}
interface TargetClient {
(source: Request, options: Options): string;
info: TargetClientInfo;
}
interface TargetInfo<C extends string> {
key: string;
title: string;
extname: string;
default: C;
}
type Target<C extends string = string> = {
info: TargetInfo<C>;
} & Record<C, TargetClient>;
}
export type HttpMethods =
| "GET"
| "POST"
| "PATCH"
| "PUT"
| "DELETE"
| "HEAD"
| "OPTIONS";
interface HttpSnippetRequest {
/** Request method (`GET`, `POST`, ...). */
method: HttpMethods;
/** Absolute URL of the request (fragments are not included). */
url: string;
/** Request HTTP Version. */
httpVersion?: "HTTP/1.0" | "HTTP/1.1" | "HTTP/2.0";
/** List of cookie objects. */
cookies?: Cookie[];
/** List of header objects. */
headers?: Header[];
/** List of query parameter objects. */
queryString?: QueryString[];
/** Posted data info. */
postData?: PostData;
/**
* Total number of bytes from the start of the HTTP request message until
* (and including) the double CRLF before the body.
*
* Set to `-1` if the info is not available.
*/
headersSize?: number;
/**
* Size of the request body (POST data payload) in bytes.
*
* Set to `-1` if the info is not available.
*/
bodySize?: number;
/** A comment provided by the user or the application */
comment?: string;
}
export type Languages =
| "c"
| "clojure"
| "csharp"
| "go"
| "http"
| "java"
| "javascript"
| "kotlin"
| "node"
| "objc"
| "ocaml"
| "php"
| "powershell"
| "python"
| "r"
| "ruby"
| "shell"
| "swift";
export type HttpClient =
| "cohttp"
| "native"
| "python3"
| "requests"
| "helpers"
| "clj_http"
| "curl"
| "wget"
| "httpie"
| "httr"
| "okhttp"
| "unirest"
| "asynchttp"
| "nethttp"
| "okhttp"
| "http2"
| "curl"
| "helpers"
| "http1"
| "restmethod"
| "webrequest"
| "common"
| "http1.1"
| "nsurlsession"
| "helpers"
| "restsharp"
| "httpclient"
| "axios"
| "fetch"
| "xhr"
| "jquery"
| "axios"
| "native"
| "request"
| "unirest"
| "fetch"
| "nsurlsession"
| "helpers"
| "libcurl"
| "native";