Skip to content

Commit b330285

Browse files
docs: add generated reference files (#2313)
1 parent 22117c2 commit b330285

File tree

1,105 files changed

+90077
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,105 files changed

+90077
-2
lines changed

docs/.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@ node_modules/
22
.docusaurus
33
.DS_Store
44
build/
5-
.stylelintrc.json
6-
content/reference
5+
.stylelintrc.json
Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
[@slack/cli-test](../index.md) / SlackCLIProcess
2+
3+
# Class: SlackCLIProcess
4+
5+
Defined in: [cli/cli-process.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L49)
6+
7+
## Constructors
8+
9+
### Constructor
10+
11+
```ts
12+
new SlackCLIProcess(
13+
command,
14+
globalOptions?,
15+
commandOptions?): SlackCLIProcess;
16+
```
17+
18+
Defined in: [cli/cli-process.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L65)
19+
20+
#### Parameters
21+
22+
##### command
23+
24+
`string`[]
25+
26+
##### globalOptions?
27+
28+
`SlackCLIGlobalOptions`
29+
30+
##### commandOptions?
31+
32+
`SlackCLICommandOptions`
33+
34+
#### Returns
35+
36+
`SlackCLIProcess`
37+
38+
## Properties
39+
40+
### command
41+
42+
```ts
43+
command: string[];
44+
```
45+
46+
Defined in: [cli/cli-process.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L53)
47+
48+
#### Description
49+
50+
The CLI command to invoke
51+
52+
***
53+
54+
### commandOptions
55+
56+
```ts
57+
commandOptions: undefined | SlackCLICommandOptions;
58+
```
59+
60+
Defined in: [cli/cli-process.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L63)
61+
62+
#### Description
63+
64+
The CLI command-specific options to pass to the command
65+
66+
***
67+
68+
### globalOptions
69+
70+
```ts
71+
globalOptions: undefined | SlackCLIGlobalOptions;
72+
```
73+
74+
Defined in: [cli/cli-process.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L58)
75+
76+
#### Description
77+
78+
The global CLI options to pass to the command
79+
80+
## Methods
81+
82+
### execAsync()
83+
84+
```ts
85+
execAsync(shellOpts?): Promise<ShellProcess>;
86+
```
87+
88+
Defined in: [cli/cli-process.ts:81](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L81)
89+
90+
#### Parameters
91+
92+
##### shellOpts?
93+
94+
`Partial`\<`SpawnOptionsWithoutStdio`\>
95+
96+
#### Returns
97+
98+
`Promise`\<`ShellProcess`\>
99+
100+
#### Description
101+
102+
Executes the command asynchronously, returning the process details once the process finishes executing
103+
104+
***
105+
106+
### execAsyncUntilOutputPresent()
107+
108+
```ts
109+
execAsyncUntilOutputPresent(output, shellOpts?): Promise<ShellProcess>;
110+
```
111+
112+
Defined in: [cli/cli-process.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L92)
113+
114+
#### Parameters
115+
116+
##### output
117+
118+
`string`
119+
120+
##### shellOpts?
121+
122+
`Partial`\<`SpawnOptionsWithoutStdio`\>
123+
124+
#### Returns
125+
126+
`Promise`\<`ShellProcess`\>
127+
128+
#### Description
129+
130+
Executes the command asynchronously, returning the process details once the process finishes executing
131+
132+
***
133+
134+
### execSync()
135+
136+
```ts
137+
execSync(shellOpts?): string;
138+
```
139+
140+
Defined in: [cli/cli-process.ts:108](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L108)
141+
142+
#### Parameters
143+
144+
##### shellOpts?
145+
146+
`Partial`\<`SpawnOptionsWithoutStdio`\>
147+
148+
#### Returns
149+
150+
`string`
151+
152+
#### Description
153+
154+
Executes the command synchronously, returning the process standard output
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# @slack/cli-test v2.1.0+cli.2.32.2
2+
3+
## Classes
4+
5+
- [SlackCLIProcess](classes/SlackCLIProcess.md)
6+
7+
## Variables
8+
9+
- [shell](variables/shell.md)
10+
- [SlackCLI](variables/SlackCLI.md)
11+
- [SlackProduct](variables/SlackProduct.md)
12+
- [SlackTracerId](variables/SlackTracerId.md)

0 commit comments

Comments
 (0)