@nut-tree/nut-js

Index

Modules

__global

Enumerations

Interfaces

Type aliases

Object literals

jestMatchers

Type aliases

FindHookCallback

FindHookCallback: function

Type declaration

- (target: MatchResult): Promise<void>
- Parameters
  - target: MatchResult
  Returns Promise<void>

StringOrKey

StringOrKey: string[] | Key[]

Functions

Const centerOf

centerOf(target: Region | Promise<Region>): Promise<Point>

- Defined in location.function.ts:8
centerOf returns the center Point for a given Region

Parameters
- target: Region | Promise<Region>
  
  to determine the center Point for
Returns Promise<Point>

Const createMovementApi

createMovementApi(native: NativeAdapter, lineHelper: LineHelper): MovementApi

- Defined in movement.function.ts:6
Parameters
- native: NativeAdapter
- lineHelper: LineHelper
Returns MovementApi

debugImage

debugImage(image: Mat, filename: string, suffix?: undefined | string): void

- Defined in provider/opencv/template-matching-finder.class.ts:39
Parameters
- image: Mat
- filename: string
- Optional suffix: undefined | string
Returns void

determineROI

determineROI(img: Image, roi: Region): Rect

- Defined in provider/opencv/image-processor.class.ts:5
Parameters
- img: Image
- roi: Region
Returns Rect

determineScaledSearchRegion

determineScaledSearchRegion(matchRequest: MatchRequest): Region

- Defined in provider/opencv/determine-searchregion.function.ts:4
Parameters
- matchRequest: MatchRequest
Returns Region

findEdges

findEdges(image: Mat): Promise<Mat>

- Defined in provider/opencv/find-edges.function.ts:3
Parameters
- image: Mat
Returns Promise<Mat>

Const generateOutputPath

generateOutputPath(filename: string, params?: undefined | object): string

- Defined in generate-output-path.function.ts:10
generateOutputPath is used to assemble full file path from a filename and various parameters

Parameters
- filename: string
  
  The base filename
- Optional params: undefined | object
  
  A config object which allows to configure FileType, base path, filename prefix and filename postfix
Returns string

Const inputIsString

inputIsString(input: string[] | Key[]): boolean

- Defined in keyboard.class.ts:7
Parameters
- input: string[] | Key[]
Returns boolean

isValidSearch

isValidSearch(needle: Mat, haystack: Mat): boolean

- Defined in provider/opencv/template-matching-finder.class.ts:59
Parameters
- needle: Mat
- haystack: Mat
Returns boolean

Const linear

linear(amountOfSteps: number, speedInPixelsPerSecond: number): number[]

- Defined in movementtype.function.ts:1
Parameters
- amountOfSteps: number
- speedInPixelsPerSecond: number
Returns number[]

loadHaystack

loadHaystack(matchRequest: MatchRequest): Promise<Mat>

- Defined in provider/opencv/template-matching-finder.class.ts:24
Parameters
- matchRequest: MatchRequest
Returns Promise<Mat>

loadNeedle

loadNeedle(image: Image): Promise<Mat>

- Defined in provider/opencv/template-matching-finder.class.ts:17
Parameters
- image: Image
Returns Promise<Mat>

lowerBound

lowerBound(value: number, boundary: number, minValue: number): number

- Defined in provider/opencv/bound-value.function.ts:1
Parameters
- value: number
- boundary: number
- minValue: number
Returns number

matchImages

matchImages(haystack: Mat, needle: Mat): Promise<MatchResult>

- Defined in provider/opencv/match-image.function.ts:5
Parameters
- haystack: Mat
- needle: Mat
Returns Promise<MatchResult>

Const randomPointIn

randomPointIn(target: Region | Promise<Region>): Promise<Point>

- Defined in location.function.ts:20
randomPointIn returns a random Point within a given Region

Parameters
- target: Region | Promise<Region>
  
  the random Point has to be within
Returns Promise<Point>

scaleImage

scaleImage(image: Mat, scaleFactor: number): Promise<Mat>

- Defined in provider/opencv/scale-image.function.ts:4
Parameters
- image: Mat
- scaleFactor: number
Returns Promise<Mat>

scaleLocation

scaleLocation(result: Region, scaleFactor: number): Region

- Defined in provider/opencv/scale-location.function.ts:4
Parameters
- result: Region
- scaleFactor: number
Returns Region

Const sleep

sleep(ms: number): Promise<unknown>

- Defined in sleep.function.ts:1
Parameters
- ms: number
Returns Promise<unknown>

timeout

timeout<R>(updateIntervalMs: number, maxDurationMs: number, action: function): Promise<R>

- Defined in util/poll-action.function.ts:1
Type parameters
- R
Parameters
- updateIntervalMs: number
- maxDurationMs: number
- action: function
  - - (...params: any): Promise<R>
    - Parameters
      - Rest ...params: any
      Returns Promise<R>
Returns Promise<R>

Const toBeAt

toBeAt(received: Mouse, position: Point): Promise<object>

- Defined in expect/matchers/toBeAt.function.ts:4
Parameters
- received: Mouse
- position: Point
Returns Promise<object>

Const toBeIn

toBeIn(received: Mouse, region: Region): Promise<object>

- Defined in expect/matchers/toBeIn.function.ts:4
Parameters
- received: Mouse
- region: Region
Returns Promise<object>

Const toShow

toShow(received: Screen, needle: string, confidence?: undefined | number): Promise<object>

- Defined in expect/matchers/toShow.function.ts:4
Parameters
- received: Screen
- needle: string
- Optional confidence: undefined | number
Returns Promise<object>

upperBound

upperBound(value: number, boundary: number, maxValue: number): number

- Defined in provider/opencv/bound-value.function.ts:5
Parameters
- value: number
- boundary: number
- maxValue: number
Returns number

Object literals

Const jestMatchers

jestMatchers: object

toBeAt

toBeAt: toBeAt

toBeIn

toBeIn: toBeIn

toShow

toShow: toShow