Interface: Registrar
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/core / Registrar
Interface: Registrar
@kui-shell/core.Registrar
Hierarchy
-
Registrar
Table of contents
Properties
Methods
Properties
listen
• listen: CommandListener
Defined in
packages/core/src/models/command.ts:329
Methods
catchall
▸ catchall<T, O>(offer, handler, prio, options?): void
Type parameters
| Name | Type |
|---|---|
T | extends KResponse<any> |
O | extends ParsedOptions |
Parameters
| Name | Type |
|---|---|
offer | CatchAllOffer |
handler | CommandHandler<T, O> |
prio | number |
options? | CommandOptions |
Returns
void
Defined in
packages/core/src/models/command.ts:348
find
▸ find<T, O>(route, fromPlugin?, noOverride?): Promise<Command<T, O>>
Type parameters
| Name | Type |
|---|---|
T | extends KResponse<any> |
O | extends ParsedOptions |
Parameters
| Name | Type |
|---|---|
route | string |
fromPlugin? | string |
noOverride? | boolean |
Returns
Promise<Command<T, O>>
Defined in
packages/core/src/models/command.ts:324
override
▸ override<T, O>(route, fromPlugin, handler, options?): Promise<Command<T, O>>
Type parameters
| Name | Type |
|---|---|
T | extends KResponse<any> |
O | extends ParsedOptions |
Parameters
| Name | Type |
|---|---|
route | string |
fromPlugin | string |
handler | CommandOverrideHandler<T, O> |
options? | CommandOptions |
Returns
Promise<Command<T, O>>
Defined in
packages/core/src/models/command.ts:330
subtree
▸ subtree<T, O>(route, options): Command<T, O>
Type parameters
| Name | Type |
|---|---|
T | extends KResponse<any> |
O | extends ParsedOptions |
Parameters
| Name | Type |
|---|---|
route | string |
options | CommandOptions |
Returns
Command<T, O>
Defined in
packages/core/src/models/command.ts:342
subtreeSynonym
▸ subtreeSynonym<T, O>(route, masterTree, options?): void
Type parameters
| Name | Type |
|---|---|
T | extends KResponse<any> |
O | extends ParsedOptions |
Parameters
| Name | Type |
|---|---|
route | string |
masterTree | Command<T, O> |
options? | CommandOptions |
Returns
void
Defined in
packages/core/src/models/command.ts:343
synonym
▸ synonym<T, O>(route, handler, master, options?): void
Type parameters
| Name | Type |
|---|---|
T | extends KResponse<any> |
O | extends ParsedOptions |
Parameters
| Name | Type |
|---|---|
route | string |
handler | CommandHandler<T, O> |
master | Command<T, O> |
options? | CommandOptions |
Returns
void