Interface Environment

Hierarchy

Environment

Methods

cleanClipboard

cleanClipboard(): Promise<void>

- Defined in context/common/environment/environment.interface.ts:20
Returns Promise<void>

copyIntoClipboard

copyIntoClipboard(): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:19
Returns Promise<Environment>

decryptSecret

decryptSecret(secret: string): Promise<string>

- Defined in context/common/environment/environment.interface.ts:27
Parameters
- secret: string
Returns Promise<string>

getClipboard

getClipboard(): Promise<string>

- Defined in context/common/environment/environment.interface.ts:14
Returns Promise<string>

getClipboardMasked

getClipboardMasked(): Promise<string>

- Defined in context/common/environment/environment.interface.ts:15
Returns Promise<string>

getEnv

getEnv(key: string): null | string

- Defined in context/common/environment/environment.interface.ts:41
Parameters
- key: string
Returns null | string

getEnvMasked

getEnvMasked(key: string): null | string

- Defined in context/common/environment/environment.interface.ts:42
Parameters
- key: string
Returns null | string

getOsIdentifier

getOsIdentifier(): string

- Defined in context/common/environment/environment.interface.ts:36
Returns string

getProperty

getProperty(key: string): null | string

- Defined in context/common/environment/environment.interface.ts:43
Parameters
- key: string
Returns null | string

getPropertyMasked

getPropertyMasked(key: string): null | string

- Defined in context/common/environment/environment.interface.ts:44
Parameters
- key: string
Returns null | string

getRegionFromFocusedWindow

getRegionFromFocusedWindow(): Promise<Region>

- Defined in context/common/environment/environment.interface.ts:13
Returns Promise<Region>

getSimilarity

getSimilarity(): number

- Defined in context/common/environment/environment.interface.ts:6
Returns number

isDarwin

isDarwin(): boolean

- Defined in context/common/environment/environment.interface.ts:35
Returns boolean

isLinux

isLinux(): boolean

- Defined in context/common/environment/environment.interface.ts:34
Returns boolean

isWindows

isWindows(): boolean

- Defined in context/common/environment/environment.interface.ts:33
Returns boolean

keyDown

keyDown(...keys: Key[]): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:28
Parameters
- Rest ...keys: Key[]
Returns Promise<Environment>

keyUp

keyUp(...keys: Key[]): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:29
Parameters
- Rest ...keys: Key[]
Returns Promise<Environment>

mouseWheelDown

mouseWheelDown(steps: number): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:31
Parameters
- steps: number
Returns Promise<Environment>

mouseWheelUp

mouseWheelUp(steps: number): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:32
Parameters
- steps: number
Returns Promise<Environment>

paste

paste(text: string): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:21
Parameters
- text: string
Returns Promise<Environment>

pasteAndDecrypt

pasteAndDecrypt(text: string): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:23
Parameters
- text: string
Returns Promise<Environment>

pasteClipboard

pasteClipboard(): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:18
Returns Promise<Environment>

pasteMasked

pasteMasked(text: string): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:22
Parameters
- text: string
Returns Promise<Environment>

resetSimilarity

resetSimilarity(): void

- Defined in context/common/environment/environment.interface.ts:8
Returns void

runCommand

runCommand(command: string, optThrowException: boolean): Promise<CommandLineResult>

- Defined in context/common/environment/environment.interface.ts:37
Parameters
- command: string
- optThrowException: boolean
Returns Promise<CommandLineResult>

setClipboard

setClipboard(text: string): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:16
Parameters
- text: string
Returns Promise<Environment>

setClipboardMasked

setClipboardMasked(text: string): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:17
Parameters
- text: string
Returns Promise<Environment>

setSimilarity

setSimilarity(similarity: number): void

- Defined in context/common/environment/environment.interface.ts:7
Parameters
- similarity: number
Returns void

sleep

sleep(s: number): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:11
Parameters
- s: number
Returns Promise<Environment>

sleepMs

sleepMs(ms: number): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:12
Parameters
- ms: number
Returns Promise<Environment>

takeScreenshot

takeScreenshot(filename: string): Promise<string>

- Defined in context/common/environment/environment.interface.ts:9
Parameters
- filename: string
Returns Promise<string>

takeScreenshotWithTimestamp

takeScreenshotWithTimestamp(filename: string): Promise<string>

- Defined in context/common/environment/environment.interface.ts:10
Parameters
- filename: string
Returns Promise<string>

type

type(text: string, ...optModifiers: Key[]): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:24
Parameters
- text: string
- Rest ...optModifiers: Key[]
Returns Promise<Environment>

typeAndDecrypt

typeAndDecrypt(text: string, ...optModifiers: Key[]): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:26
Parameters
- text: string
- Rest ...optModifiers: Key[]
Returns Promise<Environment>

typeMasked

typeMasked(text: string, ...optModifiers: Key[]): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:25
Parameters
- text: string
- Rest ...optModifiers: Key[]
Returns Promise<Environment>

write

write(text: string): Promise<Environment>

- Defined in context/common/environment/environment.interface.ts:30
Parameters
- text: string
Returns Promise<Environment>