@k8slens/extensions

Globals / "src/common/workspace-store" / WorkspaceStore

Class: WorkspaceStore

Hierarchy

• BaseStore\<WorkspaceStoreModel>

↳ WorkspaceStore

Index

Properties

• currentWorkspaceId
• data
• isLoaded
• params
• storeConfig
• syncDisposers
• whenLoaded
• workspaces
• defaultId

Accessors

• currentWorkspace
• enabledWorkspacesList
• name
• path
• syncChannel
• workspacesList

Methods

• addWorkspace
• applyWithoutSync
• cwd
• disableSync
• enableSync
• fromStore
• getById
• getByName
• getSubFrames
• init
• isDefault
• load
• onModelChange
• onSync
• onSyncFromMain
• pushState
• registerIpcListener
• removeWorkspace
• removeWorkspaceById
• saveToFile
• setActive
• syncToWebViews
• toJSON
• unregisterIpcListener
• getInstance
• resetInstance

Properties

currentWorkspaceId

• currentWorkspaceId: string = WorkspaceStore.defaultId

Defined in src/common/workspace-store.ts:104

---

data

• data: T = {} as T

Inherited from BaseStore.data

Defined in src/common/base-store.ts:24

---

isLoaded

• isLoaded: boolean = false

Inherited from BaseStore.isLoaded

Defined in src/common/base-store.ts:23

---

params

• Protected params: BaseStoreParams

Inherited from BaseStore.params

Defined in src/common/base-store.ts:26

---

storeConfig

• Protected storeConfig: Config\<WorkspaceStoreModel>

Inherited from BaseStore.storeConfig

Defined in src/common/base-store.ts:19

---

syncDisposers

• Protected syncDisposers: Function[] = []

Inherited from BaseStore.syncDisposers

Defined in src/common/base-store.ts:20

---

whenLoaded

• whenLoaded: Promise\ & { cancel: () => void } = when(() => this.isLoaded)

Inherited from BaseStore.whenLoaded

Defined in src/common/base-store.ts:22

---

workspaces

• workspaces: ObservableMap\Workspace> = observable.map\({ [WorkspaceStore.defaultId]: new Workspace({ id: WorkspaceStore.defaultId, name: "default" }) })

Defined in src/common/workspace-store.ts:106

---

defaultId

▪ Static Readonly defaultId: WorkspaceId = "default"

Defined in src/common/workspace-store.ts:78

Accessors

currentWorkspace

• get currentWorkspace(): Workspace

Defined in src/common/workspace-store.ts:113

Returns: Workspace

---

enabledWorkspacesList

• get enabledWorkspacesList(): Workspace[]

Defined in src/common/workspace-store.ts:121

Returns: Workspace[]

---

name

• get name(): string

Inherited from BaseStore.name

Defined in src/common/base-store.ts:36

Returns: string

---

path

• get path(): string

Inherited from BaseStore.path

Defined in src/common/base-store.ts:40

Returns: string

---

syncChannel

• get syncChannel(): string

Inherited from BaseStore.syncChannel

Defined in src/common/base-store.ts:44

Returns: string

---

workspacesList

• get workspacesList(): Workspace[]

Defined in src/common/workspace-store.ts:117

Returns: Workspace[]

Methods

addWorkspace

▸ addWorkspace(workspace: Workspace): Workspace

Defined in src/common/workspace-store.ts:154

Parameters:

Name	Type
workspace	Workspace

Returns: Workspace

---

applyWithoutSync

▸ ProtectedapplyWithoutSync(callback: () => void): void

Inherited from BaseStore.applyWithoutSync

Defined in src/common/base-store.ts:120

Parameters:

Name	Type
callback	() => void

Returns: void

---

cwd

▸ Protectedcwd(): string

Inherited from BaseStore.cwd

Defined in src/common/base-store.ts:71

Returns: string

---

disableSync

▸ disableSync(): void

Inherited from BaseStore.disableSync

Defined in src/common/base-store.ts:115

Returns: void

---

enableSync

▸ enableSync(): void

Inherited from BaseStore.enableSync

Defined in src/common/base-store.ts:83

Returns: void

---

fromStore

▸ ProtectedfromStore(__namedParameters: { currentWorkspace: string ; workspaces: WorkspaceModel[] = [] }): void

Overrides BaseStore.fromStore

Defined in src/common/workspace-store.ts:191

Parameters:

Name	Type
__namedParameters	{ currentWorkspace: string ; workspaces: WorkspaceModel[] = [] }

Returns: void

---

getById

▸ getById(id: WorkspaceId): Workspace

Defined in src/common/workspace-store.ts:135

Parameters:

Name	Type
id	WorkspaceId

Returns: Workspace

---

getByName

▸ getByName(name: string): Workspace

Defined in src/common/workspace-store.ts:139

Parameters:

Name	Type
name	string

Returns: Workspace

---

getSubFrames

▸ ProtectedgetSubFrames(): Promise\

Inherited from BaseStore.getSubFrames

Defined in src/common/base-store.ts:164

Returns: Promise\

---

init

▸ Protectedinit(): Promise\

Inherited from BaseStore.init

Defined in src/common/base-store.ts:48

Returns: Promise\

---

isDefault

▸ isDefault(id: WorkspaceId): boolean

Defined in src/common/workspace-store.ts:131

Parameters:

Name	Type
id	WorkspaceId

Returns: boolean

---

load

▸ load(): Promise\

Inherited from BaseStore.load

Defined in src/common/base-store.ts:58

Returns: Promise\

---

onModelChange

▸ ProtectedonModelChange(model: WorkspaceStoreModel): Promise\

Inherited from BaseStore.onModelChange

Defined in src/common/base-store.ts:135

Parameters:

Name	Type
model	WorkspaceStoreModel

Returns: Promise\

---

onSync

▸ ProtectedonSync(model: WorkspaceStoreModel): void

Inherited from BaseStore.onSync

Defined in src/common/base-store.ts:128

Parameters:

Name	Type
model	WorkspaceStoreModel

Returns: void

---

onSyncFromMain

▸ ProtectedonSyncFromMain(model: WorkspaceStoreModel): void

Inherited from BaseStore.onSyncFromMain

Defined in src/common/base-store.ts:105

Parameters:

Name	Type
model	WorkspaceStoreModel

Returns: void

---

pushState

▸ pushState(): void

Defined in src/common/workspace-store.ts:125

Returns: void

---

registerIpcListener

▸ registerIpcListener(): void

Defined in src/common/workspace-store.ts:92

Returns: void

---

removeWorkspace

▸ removeWorkspace(workspace: Workspace): void

Defined in src/common/workspace-store.ts:171

Parameters:

Name	Type
workspace	Workspace

Returns: void

---

removeWorkspaceById

▸ removeWorkspaceById(id: WorkspaceId): void

Defined in src/common/workspace-store.ts:176

Parameters:

Name	Type
id	WorkspaceId

Returns: void

---

saveToFile

▸ ProtectedsaveToFile(model: WorkspaceStoreModel): Promise\

Inherited from BaseStore.saveToFile

Defined in src/common/base-store.ts:75

Parameters:

Name	Type
model	WorkspaceStoreModel

Returns: Promise\

---

setActive

▸ setActive(id?: string, reset?: boolean): void

Defined in src/common/workspace-store.ts:144

Parameters:

Name	Type	Default value
id	string	WorkspaceStore.defaultId
reset	boolean	true

Returns: void

---

syncToWebViews

▸ ProtectedsyncToWebViews(model: WorkspaceStoreModel): Promise\

Inherited from BaseStore.syncToWebViews

Defined in src/common/base-store.ts:146

Parameters:

Name	Type
model	WorkspaceStoreModel

Returns: Promise\

---

toJSON

▸ toJSON(): WorkspaceStoreModel

Overrides BaseStore.toJSON

Defined in src/common/workspace-store.ts:207

Returns: WorkspaceStoreModel

---

unregisterIpcListener

▸ unregisterIpcListener(): void

Overrides BaseStore.unregisterIpcListener

Defined in src/common/workspace-store.ts:99

Returns: void

---

getInstance

▸ StaticgetInstance\(...args: ConstructorParameters\<Constructor\>): T

Inherited from Singleton.getInstance

Defined in src/common/utils/singleton.ts:15

Type parameters:

Name
T

Parameters:

Name	Type
...args	ConstructorParameters\<Constructor\>

Returns: T

---

resetInstance

▸ StaticresetInstance(): void

Inherited from Singleton.resetInstance

Defined in src/common/utils/singleton.ts:22

Returns: void

---

Last update: November 10, 2020