Skip to content

Commit ac93c48

Browse files
committed
Deploy documentation v7.4.0
0 parents  commit ac93c48

1,240 files changed

Lines changed: 56942 additions & 0 deletions

File tree

Some content is hidden

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

.nojekyll

Whitespace-only changes.

404.html

Lines changed: 36 additions & 0 deletions
Large diffs are not rendered by default.

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
cli.tsed.dev
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
symbol: CliCore
3+
module: "@tsed/cli-core"
4+
type: class
5+
meta:
6+
- name: keywords
7+
description: api typescript node.js documentation CliCore class
8+
---
9+
# CliCore - @tsed/cli-core
10+
11+
## Usage
12+
13+
```typescript
14+
import { CliCore } from "@tsed/cli-core";
15+
```
16+
17+
> See [/packages/cli-core/src/CliCore.ts](https://github.com/tsedio/tsed-cli/blob/v7.4.0/packages/cli-core/src/CliCore.ts#L0-L0).
18+
19+
## Overview
20+
21+
```ts
22+
class CliCore {
23+
protected constructor(settings: Partial<TsED.Configuration>);
24+
static checkPrecondition(settings: any): void;
25+
static checkPackage(pkg: any): void;
26+
static checkNodeVersion(wanted: string, id: string): typeof CliCore;
27+
static bootstrap(settings: Partial<TsED.Configuration>): Promise<CliCore>;
28+
static updateNotifier(pkg: any): Promise<typeof CliCore>;
29+
protected static getProjectRoot(argv: string[]): string;
30+
bootstrap(): Promise<this>;
31+
}
32+
```
33+
34+
<!-- Members -->
35+
36+
## static checkPrecondition
37+
38+
```ts
39+
static checkPrecondition(settings: any): void;
40+
```
41+
42+
## static checkPackage
43+
44+
```ts
45+
static checkPackage(pkg: any): void;
46+
```
47+
48+
## static checkNodeVersion
49+
50+
```ts
51+
static checkNodeVersion(wanted: string, id: string): typeof CliCore;
52+
```
53+
54+
## static bootstrap
55+
56+
```ts
57+
static bootstrap(settings: Partial<TsED.Configuration>): Promise<CliCore>;
58+
```
59+
60+
## static updateNotifier
61+
62+
```ts
63+
static updateNotifier(pkg: any): Promise<typeof CliCore>;
64+
```
65+
66+
## protected static getProjectRoot
67+
68+
```ts
69+
protected static getProjectRoot(argv: string[]): string;
70+
```
71+
72+
## bootstrap
73+
74+
```ts
75+
bootstrap(): Promise<this>;
76+
```
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
symbol: Command
3+
module: "@tsed/cli-core"
4+
type: decorator
5+
meta:
6+
- name: keywords
7+
description: api typescript node.js documentation Command decorator
8+
---
9+
# Command - @tsed/cli-core
10+
11+
## Usage
12+
13+
```typescript
14+
import { Command } from "@tsed/cli-core";
15+
```
16+
17+
> See [/packages/cli-core/src/decorators/command.ts](https://github.com/tsedio/tsed-cli/blob/v7.4.0/packages/cli-core/src/decorators/command.ts#L0-L0).
18+
19+
## Overview
20+
21+
```ts
22+
function Command<Input = any>(options: BaseCommandOptions<Input>): ClassDecorator;
23+
```
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
symbol: CliError
3+
module: "@tsed/cli-core"
4+
type: class
5+
meta:
6+
- name: keywords
7+
description: api typescript node.js documentation CliError class
8+
---
9+
# CliError - @tsed/cli-core
10+
11+
## Usage
12+
13+
```typescript
14+
import { CliError } from "@tsed/cli-core/src/domains/CliError";
15+
```
16+
17+
> See [/packages/cli-core/src/domains/CliError.ts](https://github.com/tsedio/tsed-cli/blob/v7.4.0/packages/cli-core/src/domains/CliError.ts#L0-L0).
18+
19+
## Overview
20+
21+
```ts
22+
class CliError extends Error {
23+
name: string;
24+
readonly cli: CliCore;
25+
readonly origin: Error;
26+
constructor({ cli, origin }: {
27+
cli: CliCore;
28+
origin: Error;
29+
});
30+
}
31+
```
32+
33+
<!-- Members -->
34+
35+
## name
36+
37+
```ts
38+
name: string;
39+
```
40+
41+
## readonly cli
42+
43+
```ts
44+
readonly cli: CliCore;
45+
```
46+
47+
## readonly origin
48+
49+
```ts
50+
readonly origin: Error;
51+
```
Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,238 @@
1+
---
2+
symbol: command
3+
module: "@tsed/cli-core"
4+
type: function
5+
meta:
6+
- name: keywords
7+
description: api typescript node.js documentation command function
8+
---
9+
# command - @tsed/cli-core
10+
11+
## Usage
12+
13+
```typescript
14+
import { command } from "@tsed/cli-core";
15+
```
16+
17+
> See [/packages/cli-core/src/fn/command.ts](https://github.com/tsedio/tsed-cli/blob/v7.4.0/packages/cli-core/src/fn/command.ts#L0-L0).
18+
19+
## Overview
20+
21+
```ts
22+
function command<Input>(options: CommandOptions<Input>): TsED.ProviderBuilder<FactoryTokenProvider<{
23+
$prompt: any;
24+
$exec: any;
25+
token: import("@tsed/di").TokenProvider<CommandProvider>;
26+
name: string;
27+
alias?: string;
28+
description: string;
29+
args?: {
30+
[key: string]: import("../interfaces/CommandOptions.js").CommandArg;
31+
};
32+
inputSchema?: JsonSchema<Input> | (() => JsonSchema<Input>) | undefined;
33+
options?: {
34+
[key: string]: import("../interfaces/CommandOptions.js").CommandOpts;
35+
};
36+
allowUnknownOption?: boolean;
37+
enableFeatures?: string[];
38+
disableReadUpPkg?: boolean;
39+
renderMode?: import("@tsed/cli-tasks").TasksOptions["renderMode"];
40+
} | {
41+
$prompt: any;
42+
$exec: any;
43+
handler: (data: Input) => import("@tsed/cli-tasks").MaybePromise<void | import("../interfaces/index.js").Task<Input>[]>;
44+
prompt?(initialOptions: Partial<Input>): import("@tsed/cli-prompts").PromptQuestion[] | Promise<import("@tsed/cli-prompts").PromptQuestion[]>;
45+
name: string;
46+
alias?: string;
47+
description: string;
48+
args?: {
49+
[key: string]: import("../interfaces/CommandOptions.js").CommandArg;
50+
};
51+
inputSchema?: JsonSchema<Input> | (() => JsonSchema<Input>) | undefined;
52+
options?: {
53+
[key: string]: import("../interfaces/CommandOptions.js").CommandOpts;
54+
};
55+
allowUnknownOption?: boolean;
56+
enableFeatures?: string[];
57+
disableReadUpPkg?: boolean;
58+
renderMode?: import("@tsed/cli-tasks").TasksOptions["renderMode"];
59+
}>> | TsED.ClassProviderBuilder<Type<CommandProvider<Input>>>;
60+
```
61+
62+
<!-- Members -->
63+
64+
## $prompt
65+
66+
```ts
67+
$prompt: any;
68+
```
69+
70+
## $exec
71+
72+
```ts
73+
$exec: any;
74+
```
75+
76+
## token: import
77+
78+
```ts
79+
token: import("@tsed/di").TokenProvider<CommandProvider>;
80+
```
81+
82+
## name
83+
84+
```ts
85+
name: string;
86+
```
87+
88+
## alias
89+
90+
```ts
91+
alias?: string;
92+
```
93+
94+
## description
95+
96+
```ts
97+
description: string;
98+
```
99+
100+
## args
101+
102+
```ts
103+
args?: {
104+
[key: string]: import("../interfaces/CommandOptions.js").CommandArg;
105+
};
106+
```
107+
108+
## inputSchema: JsonSchema
109+
110+
```ts
111+
inputSchema?: JsonSchema<Input> | (() => JsonSchema<Input>) | undefined;
112+
```
113+
114+
## options
115+
116+
```ts
117+
options?: {
118+
[key: string]: import("../interfaces/CommandOptions.js").CommandOpts;
119+
};
120+
```
121+
122+
## allowUnknownOption
123+
124+
```ts
125+
allowUnknownOption?: boolean;
126+
```
127+
128+
## enableFeatures
129+
130+
```ts
131+
enableFeatures?: string[];
132+
```
133+
134+
## disableReadUpPkg
135+
136+
```ts
137+
disableReadUpPkg?: boolean;
138+
```
139+
140+
## renderMode: import
141+
142+
```ts
143+
renderMode?: import("@tsed/cli-tasks").TasksOptions["renderMode"];
144+
```
145+
146+
##
147+
148+
```ts
149+
} | {
150+
```
151+
152+
## $prompt
153+
154+
```ts
155+
$prompt: any;
156+
```
157+
158+
## $exec
159+
160+
```ts
161+
$exec: any;
162+
```
163+
164+
## handler:
165+
166+
```ts
167+
handler: (data: Input) => import("@tsed/cli-tasks").MaybePromise<void | import("../interfaces/index.js").Task<Input>[]>;
168+
```
169+
170+
## prompt
171+
172+
```ts
173+
prompt?(initialOptions: Partial<Input>): import("@tsed/cli-prompts").PromptQuestion[] | Promise<import("@tsed/cli-prompts").PromptQuestion[]>;
174+
```
175+
176+
## name
177+
178+
```ts
179+
name: string;
180+
```
181+
182+
## alias
183+
184+
```ts
185+
alias?: string;
186+
```
187+
188+
## description
189+
190+
```ts
191+
description: string;
192+
```
193+
194+
## args
195+
196+
```ts
197+
args?: {
198+
[key: string]: import("../interfaces/CommandOptions.js").CommandArg;
199+
};
200+
```
201+
202+
## inputSchema: JsonSchema
203+
204+
```ts
205+
inputSchema?: JsonSchema<Input> | (() => JsonSchema<Input>) | undefined;
206+
```
207+
208+
## options
209+
210+
```ts
211+
options?: {
212+
[key: string]: import("../interfaces/CommandOptions.js").CommandOpts;
213+
};
214+
```
215+
216+
## allowUnknownOption
217+
218+
```ts
219+
allowUnknownOption?: boolean;
220+
```
221+
222+
## enableFeatures
223+
224+
```ts
225+
enableFeatures?: string[];
226+
```
227+
228+
## disableReadUpPkg
229+
230+
```ts
231+
disableReadUpPkg?: boolean;
232+
```
233+
234+
## renderMode: import
235+
236+
```ts
237+
renderMode?: import("@tsed/cli-tasks").TasksOptions["renderMode"];
238+
```

0 commit comments

Comments
 (0)