Class Venom

Retrieves the host associated with this Venom instance.

See

【Tutorial】取得應用程式上的畫面內容

Retrieves the host associated with this Venom instance.

See

【Tutorial】取得應用程式上的畫面內容

Simulates key a sequence of keyboard.

Example

// Press the 'A' key.
await venom.key(KeyCode.A)

// Press the 'Ctrl' key and 'C' key to copy.
await venom.key(KeyCode.Ctrl, KeyCode.C)
Copy

Simulates keyboard input of a specified string.

Example

// Type 'Hello World!' as keyboard input.
await venom.keyInput('Hello World!')
Copy

Simulates pressing a keyboard key.

Example

// Hold the 'A' key.
await venom.keyPress(KeyCode.A)
Copy

Simulates releasing a keyboard key.

Example

// Press the 'A' key before releasing it.
await venom.keyPress(KeyCode.A)

// Release the 'A' key.
await venom.keyRelease(KeyCode.A)
Copy

Simulates a mouse click action.

Example

// Press the left mouse button.
await venom.mouseClick()

// Press the right mouse button.
await venom.mouseClick({ key: 'right' })

// Press the left mouse button at the position (100, 100).
await venom.mouseClick({ x: 100, y: 100 })

// Press the left mouse button at the position (100, 100) in relative space.
await venom.mouseClick({ x: 100, y: 100, space: 'relative' })
Copy

Moves the mouse to the specified position.

Example

// Moves the mouse to the position (100, 100).
await venom.mouseMoveTo({ x: 100, y: 100 })

// Moves the mouse to the position (100, 100) in relative space.
await venom.mouseMoveTo({ x: 100, y: 100, space: 'relative' })
Copy

Simulates a mouse press action.

Example

// Press the left mouse button.
await venom.mousePress()

// Press the right mouse button.
// await venom.mousePress({ key: 'right' })

// Press the left mouse button at the position (100, 100).
// await venom.mousePress({ x: 100, y: 100 })

// Press the left mouse button at the position (100, 100) in relative space.
// await venom.mousePress({ x: 100, y: 100, space: 'relative' })
Copy

Simulates a mouse release action.

Example

// Press the left mouse button before releasing the mouse.
await venom.mousePress()

// Release the left mouse button.
await venom.mouseRelease()

// Release the right mouse button.
// await venom.mouseRelease({ key: 'right' })

// Release the left mouse button at the position (100, 100).
// await venom.mouseRelease({ x: 100, y: 100 })

// Release the left mouse button at the position (100, 100) in relative space.
// await venom.mouseRelease({ x: 100, y: 100, space: 'relative' })
Copy

Simulates a mouse scroll down action.

Example

// Scroll down the mouse wheel.
await venom.mouseScrollDown()

// Scroll down the mouse wheel by 3 ticks.
await venom.mouseScrollDown({ tick: 3 })

// Scroll down the mouse wheel by 3 ticks at the position (100, 100).
await venom.mouseScrollDown({ tick: 3, x: 100, y: 100 })

// Scroll down the mouse wheel by 3 ticks at the position (100, 100) in relative space.
await venom.mouseScrollDown({ tick: 3, x: 100, y: 100, space: 'relative' })
Copy

Simulates a mouse scroll up action.

Example

// Scroll up the mouse, default is one tick.
await venom.mouseScrollUp()

// Scroll up the mouse wheel by 3 ticks.
await venom.mouseScrollUp({ tick: 3 })

// Scroll up the mouse wheel by 3 ticks at the position (100, 100).
await venom.mouseScrollUp({ tick: 3, x: 100, y: 100 })

// Scroll up the mouse wheel by 3 ticks at the position (100, 100) in relative space.
await venom.mouseScrollUp({ tick: 3, x: 100, y: 100, space: 'relative' })
Copy

Creates a Venom instance based on the provided URL, window context, and host descriptor.