Skip to content

Commit 9035dba

Browse files
committed
Add uart.d.ts TypeScript typing
1 parent 5f17c48 commit 9035dba

File tree

1 file changed

+107
-0
lines changed

1 file changed

+107
-0
lines changed

uart.d.ts

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
interface EspruinoConnection {
2+
close(): Promise<void>;
3+
emit(
4+
event: 'open' | 'close' | 'data' | 'error' | 'ack' | 'nak' | 'packet',
5+
...args: unknown[]
6+
): void;
7+
espruinoEval<R>(expr: string, options?: EspruinoEvalOptions): Promise<R>;
8+
espruinoReceiveFile(
9+
filename: string,
10+
options?: EspruinoFileOptions,
11+
): Promise<string>;
12+
espruinoSendPacket(
13+
type: string,
14+
data: string,
15+
options?: EspruinoPacketOptions,
16+
): Promise<void>;
17+
espruinoSendFile(
18+
filename: string,
19+
data: string,
20+
options?: EspruinoFileOptions,
21+
): Promise<void>;
22+
hadData: boolean;
23+
isOpen: boolean;
24+
isOpening: boolean;
25+
on(
26+
event: 'open' | 'close' | 'data' | 'error' | 'ack' | 'nak' | 'packet',
27+
callback: (...args: unknown[]) => void,
28+
): void;
29+
parsePackets: boolean;
30+
received: string;
31+
removeListener(
32+
event: 'open' | 'close' | 'data' | 'error' | 'ack' | 'nak' | 'packet',
33+
callback: (...args: unknown[]) => void,
34+
): void;
35+
rxDataHandler(data: string): void;
36+
txInProgress: boolean;
37+
write(
38+
data: string,
39+
callback?: () => void,
40+
alreadyRetried?: boolean,
41+
): Promise<void>;
42+
}
43+
44+
interface EspruinoPacketOptions {
45+
noACK?: boolean;
46+
}
47+
48+
interface EspruinoFileOptions {
49+
chunkSize?: number;
50+
fs?: boolean;
51+
noACK?: boolean;
52+
progress?: (chunkNo: number, chunkCount: number) => void;
53+
timeout?: number;
54+
}
55+
56+
interface EspruinoEvalOptions {
57+
stmFix?: boolean;
58+
timeout?: number;
59+
}
60+
61+
interface UartStatic {
62+
baud: number;
63+
close(): void;
64+
connect(
65+
callback: (connection: EspruinoConnection | null, error?: unknown) => void,
66+
options?: UartConnectionOptions,
67+
): EspruinoConnection;
68+
connectAsync(options?: UartConnectionOptions): Promise<EspruinoConnection>;
69+
debug: number;
70+
endpoints: UartEndpoint[];
71+
eval(
72+
expression: string,
73+
callback?: (result: unknown, status?: string) => void,
74+
): Promise<unknown>;
75+
flowControl: boolean;
76+
getConnection(): EspruinoConnection | undefined;
77+
getConnectionAsync(): Promise<EspruinoConnection>;
78+
isConnected(): boolean;
79+
log(level: number, message: string): void;
80+
modal(callback: () => void): void;
81+
optionsBluetooth: Record<string, unknown>;
82+
optionsSerial: Record<string, unknown>;
83+
ports: string[];
84+
setTime(callback?: () => void): void;
85+
version: string;
86+
write(
87+
data: string,
88+
callback?: (data: string) => void,
89+
callbackNewline?: boolean,
90+
): Promise<string>;
91+
writeProgress(charsSent?: number, charsTotal?: number): void;
92+
}
93+
94+
interface UartEndpoint {
95+
connect(
96+
connection: EspruinoConnection,
97+
options?: UartConnectionOptions,
98+
): Promise<EspruinoConnection>;
99+
description: string;
100+
isSupported(): true | string;
101+
name: string;
102+
svg: string;
103+
}
104+
105+
interface UartConnectionOptions {
106+
serialPort?: unknown;
107+
}

0 commit comments

Comments
 (0)