Kui API Documentation - v11.0.0 / @kui-shell/core / PreloadRegistrar

Interface: PreloadRegistrar

@kui-shell/core.PreloadRegistrar

Hierarchy

• Registrar

  ↳ PreloadRegistrar

Table of contents

Properties

• listen

Methods

• catchall
• find
• override
• registerBadge
• registerBadges
• registerMode
• registerModes
• registerSessionInitializer
• subtree
• subtreeSynonym
• synonym

Properties

listen

• listen: CommandListener

Inherited from

Registrar.listen

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

Inherited from

Registrar.catchall

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>>

Inherited from

Registrar.find

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>>

Inherited from

Registrar.override

Defined in

packages/core/src/models/command.ts:330

---

registerBadge

▸ registerBadge<Resource>(registration): void

sidecar badges

Type parameters

Name	Type
Resource	extends ResourceWithMetadata<void, Resource>

Parameters

Name	Type
registration	BadgeRegistration<Resource>

Returns

void

Defined in

packages/core/src/models/plugin.ts:34

---

registerBadges

▸ registerBadges<Resource>(...registrations): void

Type parameters

Name	Type
Resource	extends ResourceWithMetadata<void, Resource>

Parameters

Name	Type
...registrations	BadgeRegistration<Resource>[]

Returns

void

Defined in

packages/core/src/models/plugin.ts:35

---

registerMode

▸ registerMode<Resource>(registration): void

sidecar modes

Type parameters

Name	Type
Resource	extends ResourceWithMetadata<void, Resource>

Parameters

Name	Type
registration	ModeRegistration<Resource>

Returns

void

Defined in

packages/core/src/models/plugin.ts:30

---

registerModes

▸ registerModes<Resource>(...registrations): void

Type parameters

Name	Type
Resource	extends ResourceWithMetadata<void, Resource>

Parameters

Name	Type
...registrations	ModeRegistration<Resource>[]

Returns

void

Defined in

packages/core/src/models/plugin.ts:31

---

registerSessionInitializer

▸ registerSessionInitializer(init): void

session initializers

Parameters

Name	Type
init	SessionInitializer

Returns

void

Defined in

packages/core/src/models/plugin.ts:38

---

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>

Inherited from

Registrar.subtree

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

Inherited from

Registrar.subtreeSynonym

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

Inherited from

Registrar.synonym

Defined in

packages/core/src/models/command.ts:336