this repo has no description
improve documentation
+26
-8
+26
-8
readme.md
+26
-8
readme.md
···
10
10
11
11
## API
12
12
13
+
- [`getTerminalDefaultProfile`](#getterminaldefaultprofile)
14
+
- [`getTerminalProfiles`](#getterminalprofiles)
15
+
- [`isTerminalRunning`](#isterminalrunning)
16
+
- [`setTerminalDefaultProfile`](#setterminaldefaultprofile)
17
+
- [`setTerminalProfile`](#setterminalprofile)
18
+
13
19
### `getTerminalDefaultProfile()`
14
20
21
+
Get the default Terminal profile
22
+
23
+
#### Signature
24
+
15
25
```typescript
16
26
function getTerminalDefaultProfile(): Promise<string>;
17
27
```
···
26
36
27
37
### `getTerminalProfiles()`
28
38
39
+
Get the list of installed Terminal profiles
40
+
41
+
#### Signature
42
+
29
43
```typescript
30
44
function getTerminalProfiles(): Promise<string[]>;
31
45
```
32
-
33
-
Get a list of installed Terminal profiles
34
46
35
47
#### Example
36
48
···
42
54
43
55
### `isTerminalRunning()`
44
56
57
+
Determine whether Terminal is currently running
58
+
59
+
#### Signature
60
+
45
61
```typescript
46
62
function isTerminalRunning(): Promise<boolean>;
47
63
```
48
-
49
-
Determine whether Terminal is currently running
50
64
51
65
#### Example
52
66
···
57
71
```
58
72
59
73
### `setTerminalDefaultProfile()`
74
+
75
+
Update the default Terminal profile
76
+
77
+
#### Signature
60
78
61
79
```typescript
62
80
function setTerminalDefaultProfile(profile: string): Promise<void>;
63
81
```
64
82
65
-
Set the default Terminal profile for new windows / tabs
66
-
67
83
#### Example
68
84
69
85
```javascript
···
74
90
75
91
### `setTerminalProfile()`
76
92
93
+
Update the Terminal profile for all open tabs and windows, and optionally update the default profile at the same time
94
+
95
+
#### Signature
96
+
77
97
```typescript
78
98
function setTerminalProfile({
79
99
profile: string,
80
100
setDefault?: boolean = false
81
101
}): Promise<void>;
82
102
```
83
-
84
-
Update all open Terminal tabs to the given profile
85
103
86
104
#### Examples
87
105