You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/src/pages/en/api.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -228,6 +228,25 @@ Options that can be passed to the `run` or `runWithoutClosing` method to modify
228
228
| usePlugins |`boolean`| false | The choice of if the built CLI should look for a config file and plugins or not. |
229
229
| cliName |`string`| false | The name of the CLI and the prefix for the config file to be looked for. Defaults to `"nest-commander"`. |
230
230
231
+
### CommandRunner
232
+
233
+
The `CommandRunner` is abstract class to define your command. You define the command in the class inherits it.
234
+
235
+
#### registerWithSubCommands
236
+
237
+
A static method returns list of root command class which calls this api and all sub command classes set as metadata of `@Command` and `@SubCommand` decorators in the scope of module tree the root command class traverses.
| meta | string | false |`@Command` or `@SubCommand` id is explicitly specified for extracting metadata, It is used internal this library and you shouldn't need to specify it normally. |
0 commit comments