1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
|
8 | declare namespace mockjs {
|
9 | type N = number;
|
10 | type S = string;
|
11 | type B = boolean;
|
12 |
|
13 |
|
14 | interface Mockjs {
|
15 | mock: MockjsMock;
|
16 | setup: MockjsSetup;
|
17 | Random: MockjsRandom;
|
18 | valid: MockjsValid;
|
19 | toJSONSchema: MockjsToJSONSchema;
|
20 | version: number;
|
21 | }
|
22 |
|
23 | interface MockjsRequestOptions {
|
24 | url: string;
|
25 | type: string;
|
26 | body: any;
|
27 | }
|
28 |
|
29 | type templateOrFn = ((options: MockjsRequestOptions) => any) | object;
|
30 |
|
31 | // Mockjs.mock()
|
32 | // see https://github.com/nuysoft/Mock/wiki/Mock.mock()
|
33 | interface MockjsMock {
|
34 | (rurl: S | RegExp, rtype: S, template: templateOrFn): Mockjs;
|
35 |
|
36 | (rurl: S | RegExp, template: templateOrFn): Mockjs;
|
37 |
|
38 | (template: any): any;
|
39 | }
|
40 |
|
41 | interface MockjsSetupSettings {
|
42 | timeout?: number | S | undefined;
|
43 | }
|
44 |
|
45 | // Mockjs.setup()
|
46 | // see https://github.com/nuysoft/Mock/wiki/Mock.setup()
|
47 | type MockjsSetup = (settings: MockjsSetupSettings) => void;
|
48 |
|
49 |
|
50 |
|
51 | interface MockjsRandomBasic {
|
52 |
|
53 | boolean(min: N, max: N, current: B): B;
|
54 | boolean(): B;
|
55 |
|
56 |
|
57 | natural(min?: N, max?: N): N;
|
58 |
|
59 |
|
60 | integer(min?: N, max?: N): N;
|
61 |
|
62 |
|
63 | float(min?: N, max?: N, dmin?: N, dmax?: N): N;
|
64 |
|
65 |
|
66 | character(pool: 'lower' | 'upper' | 'number' | 'symbol'): S;
|
67 | character(pool?: S): S;
|
68 |
|
69 |
|
70 | string(pool?: S | N, min?: N, max?: N): S;
|
71 |
|
72 |
|
73 | range(start?: N, stop?: N, step?: N): N[];
|
74 | }
|
75 |
|
76 |
|
77 |
|
78 | type RandomDateUtilString = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second' | 'week';
|
79 | interface MockjsRandomDate {
|
80 |
|
81 | date(format?: S): S;
|
82 |
|
83 |
|
84 | time(format?: S): S;
|
85 |
|
86 |
|
87 | datetime(format?: S): S;
|
88 |
|
89 |
|
90 | now(util: RandomDateUtilString, format?: S): S;
|
91 | now(format?: S): S;
|
92 | }
|
93 |
|
94 |
|
95 |
|
96 | type RandomImageFormatString = 'png' | 'gif' | 'jpg';
|
97 | interface MockjsRandomImage {
|
98 |
|
99 | image(size?: S, background?: S, foreground?: S, format?: RandomImageFormatString | S, text?: S): S;
|
100 |
|
101 |
|
102 | dataImage(size?: S, text?: S): S;
|
103 | }
|
104 |
|
105 |
|
106 |
|
107 | interface MockjsRandomColor {
|
108 |
|
109 | color(): S;
|
110 |
|
111 |
|
112 | hex(): S;
|
113 |
|
114 |
|
115 | rgb(): S;
|
116 |
|
117 |
|
118 | rgba(): S;
|
119 |
|
120 |
|
121 | hsl(): S;
|
122 | }
|
123 |
|
124 |
|
125 |
|
126 | interface MockjsRandomText {
|
127 |
|
128 | paragraph(min?: N, max?: N): S;
|
129 |
|
130 |
|
131 | cparagraph(min?: N, max?: N): S;
|
132 |
|
133 |
|
134 | sentence(min?: N, max?: N): S;
|
135 |
|
136 |
|
137 | csentence(min?: N, max?: N): S;
|
138 |
|
139 |
|
140 | word(min?: N, max?: N): S;
|
141 |
|
142 |
|
143 | cword(pool?: S | N, min?: N, max?: N): S;
|
144 |
|
145 |
|
146 | title(min?: N, max?: N): S;
|
147 |
|
148 |
|
149 | ctitle(min?: N, max?: N): S;
|
150 | }
|
151 |
|
152 |
|
153 |
|
154 | interface MockjsRandomName {
|
155 |
|
156 | first(): S;
|
157 |
|
158 |
|
159 | last(): S;
|
160 |
|
161 |
|
162 | name(middle?: B): S;
|
163 |
|
164 |
|
165 | cfirst(): S;
|
166 |
|
167 |
|
168 | clast(): S;
|
169 |
|
170 |
|
171 | cname(): S;
|
172 | }
|
173 |
|
174 |
|
175 |
|
176 | type RandomWebProtocal =
|
177 | | 'http'
|
178 | | 'ftp'
|
179 | | 'gopher'
|
180 | | 'mailto'
|
181 | | 'mid'
|
182 | | 'cid'
|
183 | | 'news'
|
184 | | 'nntp'
|
185 | | 'prospero'
|
186 | | 'telnet'
|
187 | | 'rlogin'
|
188 | | 'tn3270'
|
189 | | 'wais';
|
190 | interface MockjsRandomWeb {
|
191 |
|
192 | url(protocol?: S, host?: S): S;
|
193 |
|
194 |
|
195 | protocal(): RandomWebProtocal;
|
196 |
|
197 |
|
198 | domain(): S;
|
199 |
|
200 |
|
201 | dtl(): S;
|
202 |
|
203 |
|
204 | email(domain?: S): S;
|
205 |
|
206 |
|
207 | ip(): S;
|
208 | }
|
209 |
|
210 |
|
211 |
|
212 | interface MockjsRandomAddress {
|
213 |
|
214 | region(): S;
|
215 |
|
216 |
|
217 | province(): S;
|
218 |
|
219 |
|
220 | city(prefix?: B): S;
|
221 |
|
222 |
|
223 | county(prefix?: B): S;
|
224 |
|
225 |
|
226 | zip(prefix?: B): S;
|
227 | }
|
228 |
|
229 |
|
230 |
|
231 | interface MockjsRandomHelper {
|
232 |
|
233 | capitalize(word: S): S;
|
234 |
|
235 |
|
236 | upper(str: S): S;
|
237 |
|
238 |
|
239 | lower(str: S): S;
|
240 |
|
241 |
|
242 | pick(arr: any[]): any;
|
243 |
|
244 |
|
245 | shuffle(arr: any[]): any[];
|
246 | }
|
247 |
|
248 |
|
249 |
|
250 | interface MockjsRandomMiscellaneous {
|
251 |
|
252 | guid(): S;
|
253 |
|
254 |
|
255 | id(): S;
|
256 |
|
257 |
|
258 | increment(step?: N): N;
|
259 | }
|
260 |
|
261 | interface MockjsRandomExtendOption {
|
262 | [randomType: string]: (...args: any[]) => any;
|
263 | }
|
264 |
|
265 |
|
266 |
|
267 | interface MockjsRandom
|
268 | extends MockjsRandomBasic,
|
269 | MockjsRandomDate,
|
270 | MockjsRandomImage,
|
271 | MockjsRandomColor,
|
272 | MockjsRandomAddress,
|
273 | MockjsRandomHelper,
|
274 | MockjsRandomMiscellaneous,
|
275 | MockjsRandomName,
|
276 | MockjsRandomText,
|
277 | MockjsRandomWeb,
|
278 | MockjsRandomExtendOption {
|
279 |
|
280 | extend(extendOption: MockjsRandomExtendOption): MockjsRandom;
|
281 | }
|
282 |
|
283 | interface MockjsValidRsItem {
|
284 | action: S;
|
285 | actual: S;
|
286 | expected: S;
|
287 | message: S;
|
288 | path: S[];
|
289 | type: S;
|
290 | }
|
291 |
|
292 |
|
293 |
|
294 | type MockjsValid = (template: any, data: any) => MockjsValidRsItem[];
|
295 |
|
296 | interface MockjsToJSONSchemaRs {
|
297 | name: S | undefined;
|
298 | template: any;
|
299 | type: S;
|
300 | rule: object;
|
301 | path: S[];
|
302 | properties?: MockjsToJSONSchemaRs[] | undefined;
|
303 | items?: MockjsToJSONSchemaRs[] | undefined;
|
304 | }
|
305 |
|
306 |
|
307 |
|
308 | type MockjsToJSONSchema = (template: any) => MockjsToJSONSchemaRs;
|
309 |
|
310 | let mock: MockjsMock;
|
311 | let setup: MockjsSetup;
|
312 | let Random: MockjsRandom;
|
313 | let valid: MockjsValid;
|
314 | let toJSONSchema: MockjsToJSONSchema;
|
315 | let version: number;
|
316 | }
|
317 |
|
318 | export = mockjs;
|