Skip to content

Latest commit

 

History

History
152 lines (81 loc) · 3.29 KB

kui_shell_core.Capabilities.md

File metadata and controls

152 lines (81 loc) · 3.29 KB

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

Namespace: Capabilities

@kui-shell/core.Capabilities

Table of contents

Type aliases

Functions

Type aliases

CapabilityRegistration

Ƭ CapabilityRegistration: (registrar: PreloadRegistrar) => void | Promise<void>

Type declaration

▸ (registrar): void | Promise<void>

Parameters
Name Type
registrar PreloadRegistrar
Returns

void | Promise<void>

Defined in

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

Functions

assertHasProxy

Const assertHasProxy(): void

Assert that Kui is supported by a remote proxy

Returns

void

Defined in

packages/core/src/core/capabilities.ts:96


assertLocalAccess

Const assertLocalAccess(): void

Assert that we have local access, even if the default behavior would indicate otherwise

Returns

void

Defined in

packages/core/src/core/capabilities.ts:121


hasProxy

Const hasProxy(): boolean

Is Kui supported by a remote proxy?

Returns

boolean

Defined in

packages/core/src/core/capabilities.ts:90


inBrowser

Const inBrowser(): boolean

Returns

boolean

Defined in

packages/core/src/core/capabilities.ts:73


inElectron

Const inElectron(): boolean

Returns

boolean

Defined in

packages/core/src/core/capabilities.ts:72


inProxy

Const inProxy(): boolean

Are we the Kui proxy?

Returns

boolean

Defined in

packages/core/src/core/capabilities.ts:104


isHeadless

Const isHeadless(): boolean

Returns

boolean

Defined in

packages/core/src/core/capabilities.ts:71