forked from sindresorhus/clipboardy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
71 lines (51 loc) · 1.06 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
declare const clipboard: {
/**
Write (copy) to the clipboard asynchronously.
@param text - The text to write to the clipboard.
@example
```
import clipboard from 'clipboardy';
await clipboard.write('🦄');
await clipboard.read();
//=> '🦄'
```
*/
write(text: string): Promise<void>;
/**
Read (paste) from the clipboard asynchronously.
@example
```
import clipboard from 'clipboardy';
await clipboard.write('🦄');
await clipboard.read();
//=> '🦄'
```
*/
read(): Promise<string>;
/**
Write (copy) to the clipboard synchronously.
__Doesn't work in browsers.__
@param text - The text to write to the clipboard.
@example
```
import clipboard from 'clipboardy';
clipboard.writeSync('🦄');
clipboard.readSync();
//=> '🦄'
```
*/
writeSync(text: string): void;
/**
Read (paste) from the clipboard synchronously.
__Doesn't work in browsers.__
@example
```
import clipboard from 'clipboardy';
clipboard.writeSync('🦄');
clipboard.readSync();
//=> '🦄'
```
*/
readSync(): string;
};
export default clipboard;