Class: TabState
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/core / TabState
Class: TabState
@kui-shell/core.TabState
State that we want to keep per tab
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new TabState(uuid, _desiredStatusStripeDecoration?, _parent?)
Parameters
| Name | Type |
|---|---|
uuid | string |
_desiredStatusStripeDecoration | StatusStripeChangeEvent |
_parent? | TabState |
Defined in
packages/core/src/models/tab-state.ts:68
Properties
_state
• Private _state: Record<string, Record<string, any>> = {}
state map
outer key is TabStateRegistrar.name, inner key is TabStateRegistrar.apiVersion
e.g. { 'plugins/plugin-core': {'v1': {'cwd': '/'}}}
Defined in
packages/core/src/models/tab-state.ts:57
captures
• Private captures: CaptureFn[] = []
functions to capture the states of tab
Defined in
packages/core/src/models/tab-state.ts:60
closed
• closed: boolean
is the tab closed?
Defined in
packages/core/src/models/tab-state.ts:51
ready
• ready: boolean = false
is the tab ready for command execution?
Defined in
packages/core/src/models/tab-state.ts:48
restores
• Private restores: RestoreFn[] = []
functions to restore the states of the tab
Defined in
packages/core/src/models/tab-state.ts:63
switchTos
• Private switchTos: SwitchToFn[] = []
functions to capture this tab state and restore another tab state
Defined in
packages/core/src/models/tab-state.ts:66
uuid
• Readonly uuid: string
Accessors
desiredStatusStripeDecoration
• get desiredStatusStripeDecoration(): StatusStripeChangeEvent
Returns
Defined in
packages/core/src/models/tab-state.ts:154
• set desiredStatusStripeDecoration(decor): void
Parameters
| Name | Type |
|---|---|
decor | StatusStripeChangeEvent |
Returns
void
Defined in
packages/core/src/models/tab-state.ts:158
state
• get state(): Record<string, Record<string, any>>
Returns
Record<string, Record<string, any>>
Defined in
packages/core/src/models/tab-state.ts:78
Methods
capture
▸ capture(): void
Capture contextual global state
Returns
void
Defined in
packages/core/src/models/tab-state.ts:124
checkExistence
▸ Private checkExistence(name, apiVersion): boolean
Parameters
| Name | Type |
|---|---|
name | string |
apiVersion | string |
Returns
boolean
Defined in
packages/core/src/models/tab-state.ts:82
cloneWithUUID
▸ cloneWithUUID(uuid): TabState
Clone the captured state
Parameters
| Name | Type |
|---|---|
uuid | string |
Returns
Defined in
packages/core/src/models/tab-state.ts:137
getState
▸ getState(name, apiVersion, key): any
Parameters
| Name | Type |
|---|---|
name | string |
apiVersion | string |
key | string |
Returns
any
Defined in
packages/core/src/models/tab-state.ts:107
register
▸ register(name, apiVersion, capture, restore, switchTo): void
Parameters
| Name | Type |
|---|---|
name | string |
apiVersion | string |
capture | CaptureFn |
restore | RestoreFn |
switchTo | SwitchToFn |
Returns
void
Defined in
packages/core/src/models/tab-state.ts:92
restore
▸ restore(): Promise<void>
Restore tab state
Returns
Promise<void>
Defined in
packages/core/src/models/tab-state.ts:171
setState
▸ setState(name, apiVersion, key, value): Promise<void>
Parameters
| Name | Type |
|---|---|
name | string |
apiVersion | string |
key | string |
value | any |
Returns
Promise<void>
Defined in
packages/core/src/models/tab-state.ts:117
switchTo
▸ switchTo(nextTabState): Promise<void>
Capture contextual global state and then restore nextTabState
Parameters
| Name | Type |
|---|---|
nextTabState | TabState |
Returns
Promise<void>
Defined in
packages/core/src/models/tab-state.ts:129
updateStatusStripe
▸ updateStatusStripe(): void
Enforce our desired status stripe decorations
Returns
void