Class ElectronMiniBrowserEnvironment

Fetch values from the backend's environment and caches them locally. Helps with deploying various mini-browser endpoints.

Hierarchy (View Summary)

MiniBrowserEnvironment
- ElectronMiniBrowserEnvironment

Index

Constructors

Properties

_hostPattern? _hostPatternPromise electronSecurityToken environment

Accessors

hostPattern hostPatternPromise

Methods

getDefaultHostname getEndpoint getHostPattern getRandomEndpoint init onStart

Constructors

constructor

new ElectronMiniBrowserEnvironment(): ElectronMiniBrowserEnvironment
Returns ElectronMiniBrowserEnvironment
Inherited from MiniBrowserEnvironment.constructor

Properties

`Protected` `Optional`_hostPattern

_hostPattern?: string

`Protected`_hostPatternPromise

_hostPatternPromise: Promise<string>

`Protected` `Readonly`electronSecurityToken

electronSecurityToken: ElectronSecurityToken

`Protected`environment

environment: EnvVariablesServer

Accessors

hostPattern

get hostPattern(): undefined | string
Returns undefined | string
Inherited from MiniBrowserEnvironment.hostPattern
- Defined in packages/mini-browser/src/browser/environment/mini-browser-environment.ts:47

hostPatternPromise

get hostPatternPromise(): Promise<string>
Returns Promise<string>
Inherited from MiniBrowserEnvironment.hostPatternPromise
- Defined in packages/mini-browser/src/browser/environment/mini-browser-environment.ts:43

Methods

`Protected`getDefaultHostname

getDefaultHostname(): string
Returns string
Overrides MiniBrowserEnvironment.getDefaultHostname
- Defined in packages/mini-browser/src/electron-browser/environment/electron-mini-browser-environment.ts:38

getEndpoint

getEndpoint(uuid: string, hostname?: string): Endpoint
Throws if hostPatternPromise is not yet resolved.
Parameters
- uuid: string
- Optionalhostname: string
Returns Endpoint
Overrides MiniBrowserEnvironment.getEndpoint
- Defined in packages/mini-browser/src/electron-browser/environment/electron-mini-browser-environment.ts:31

`Protected`getHostPattern

getHostPattern(): Promise<string>
Returns Promise<string>
Inherited from MiniBrowserEnvironment.getHostPattern
- Defined in packages/mini-browser/src/browser/environment/mini-browser-environment.ts:77

getRandomEndpoint

getRandomEndpoint(): Endpoint
Throws if hostPatternPromise is not yet resolved.

Returns Endpoint
Inherited from MiniBrowserEnvironment.getRandomEndpoint
- Defined in packages/mini-browser/src/browser/environment/mini-browser-environment.ts:73

`Protected`init

init(): void
Returns void
Inherited from MiniBrowserEnvironment.init
- Defined in packages/mini-browser/src/browser/environment/mini-browser-environment.ts:38

onStart

onStart(): Promise<void>
Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously.

Returns Promise<void>
Inherited from MiniBrowserEnvironment.onStart
- Defined in packages/mini-browser/src/browser/environment/mini-browser-environment.ts:51