Interface IEnvironmentService

Environment service interface. Manages compute environments for notebooks.

interface IEnvironmentService {
    state: ServiceState;
    dispose(): Promise<void>;
    getDefaultEnvironment(): Promise<null | Environment>;
    getEnvironment(environmentId: string): Promise<null | Environment>;
    initialize(): Promise<void>;
    listEnvironments(): Promise<Environment[]>;
    refreshEnvironments(): Promise<Environment[]>;
}

Hierarchy (View Summary)

ILifecycle
- IEnvironmentService

Implemented by

EnvironmentService

Index

Properties

Methods

dispose getDefaultEnvironment getEnvironment initialize listEnvironments refreshEnvironments

Properties

`Readonly`state

state: ServiceState

Current state of the service.

Methods

dispose

dispose(): Promise<void>
Disposes the service and cleans up resources. Should be called during application shutdown.

Returns Promise<void>
Inherited from ILifecycle.dispose
- Defined in src/renderer/services/interfaces/ILifecycle.ts:38

getDefaultEnvironment

getDefaultEnvironment(): Promise<null | Environment>
Get the default environment.

Returns Promise<null | Environment>
- Defined in src/renderer/services/interfaces/IEnvironmentService.ts:37

getEnvironment

getEnvironment(environmentId: string): Promise<null | Environment>
Get a specific environment by ID.
Parameters
- environmentId: string
Returns Promise<null | Environment>
- Defined in src/renderer/services/interfaces/IEnvironmentService.ts:32

initialize

initialize(): Promise<void>
Initializes the service. Should be called before any other service methods.

Returns Promise<void>
Inherited from ILifecycle.initialize
- Defined in src/renderer/services/interfaces/ILifecycle.ts:32

listEnvironments

listEnvironments(): Promise<Environment[]>
List all available environments.

Returns Promise<Environment[]>
- Defined in src/renderer/services/interfaces/IEnvironmentService.ts:27

refreshEnvironments

refreshEnvironments(): Promise<Environment[]>
Refresh environments list from API. Returns the refreshed list of environments.

Returns Promise<Environment[]>
- Defined in src/renderer/services/interfaces/IEnvironmentService.ts:43