forked from DefinitelyTyped/DefinitelyTyped
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.d.ts
180 lines (148 loc) · 8.76 KB
/
index.d.ts
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
170
171
172
173
174
175
176
177
178
179
180
/// <reference types="node" />
export interface Parser<O extends object | undefined = undefined> {
parse(buffer: Buffer, callback?: (err?: Error, result?: any) => void): Parser.Parsed<O>;
create(constructorFunction: ObjectConstructor): Parser;
int8<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
uint8<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
int16<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
uint16<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
int16le<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
int16be<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
uint16le<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
uint16be<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
int32<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
uint32<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
int32le<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
int32be<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
uint32le<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
uint32be<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
int64<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, bigint>;
uint64<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, bigint>;
int64le<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, bigint>;
int64be<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, bigint>;
uint64le<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, bigint>;
uint64be<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, bigint>;
bit1<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit2<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit3<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit4<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit5<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit6<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit7<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit8<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit9<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit10<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit11<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit12<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit13<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit14<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit15<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit16<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit17<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit18<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit19<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit20<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit21<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit22<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit23<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit24<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit25<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit26<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit27<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit28<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit29<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit30<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit31<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
bit32<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
float<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
floatle<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
floatbe<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
double<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
doublele<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
doublebe<N extends string>(name: N, options?: Parser.Options): Parser.Next<O, N, number>;
string<N extends string>(name: N, options?: Parser.StringOptions): Parser.Next<O, N, string>;
buffer<N extends string>(name: N, options: Parser.BufferOptions): Parser.Next<O, N, Buffer>;
array<N extends string, Q extends Parser.ArrayOptions>(
name: N,
options: Q,
): Parser.Next<
O,
N,
Q extends { type: infer T } ? T extends Parser<infer O> ? O extends undefined ? Array<{}> : O[]
: T extends string ? number[]
: never
: never
>;
choice<N extends string, Q extends Parser.ChoiceOptions>(name: N, options: Q): Parser.Next<
O,
N,
Q extends {
choices: infer C;
} ? C extends {
[key in keyof C]: infer T;
} ? T extends Parser<infer O> ? O extends undefined ? {} : O
: T extends string ? any
: never
: never
: never
>;
nest<N extends string, Q extends Parser.NestOptions>(
name: N,
options: Q,
): Parser.Next<
O,
N,
Q extends { type: infer T } ? T extends Parser<infer O> ? O extends undefined ? {} : O
: never
: never
>;
skip(length: number): Parser<O>;
seek(length: number): Parser<O>;
endianness(endianness: Parser.Endianness): Parser<O>; /* [sic] */
namely(alias: string): Parser<O>;
compile(): void;
getCode(): string;
}
export interface ParserConstructor {
new(): Parser;
}
export const Parser: ParserConstructor;
export namespace Parser {
type Data = number | string | Array<number | Parser<any>> | Parser<any> | Buffer;
type Parsed<O extends object | undefined> = O extends undefined ? {} : O;
interface Options {
formatter?: ((value: Data) => any) | undefined;
assert?: string | number | ((value: Data) => boolean) | undefined;
}
interface StringOptions extends Options {
encoding?: string | undefined;
length?: number | string | ((this: Parser<any>) => number) | undefined;
zeroTerminated?: boolean | undefined;
greedy?: boolean | undefined;
stripNull?: boolean | undefined;
}
interface BufferOptions extends Options {
clone?: boolean | undefined;
length?: number | string | ((this: Parser<any>) => number) | undefined;
readUntil?: string | ((item: number, buffer: Buffer) => boolean) | undefined;
}
interface ArrayOptions extends Options {
type: string | Parser<any>;
length?: number | string | ((this: Parser<any>) => number) | undefined;
lengthInBytes?: number | string | ((this: Parser<any>) => number) | undefined;
readUntil?: string | ((item: number, buffer: Buffer) => boolean) | undefined;
}
interface ChoiceOptions extends Options {
tag: string | ((this: Parser<any>) => number);
choices: { [item: number]: Parser<any> | string };
defaultChoice?: Parser<any> | string | undefined;
}
interface NestOptions extends Options {
type: Parser<any>;
}
type Endianness =
| "little"
| "big";
type Valid<O extends object | undefined, P extends object> = O extends undefined ? P : O & P;
type Next<O extends object | undefined, N extends string, T extends any> = Parser<Valid<O, { [name in N]: T }>>;
}