Kind: ImageFinder provider
1npm i @nut-tree/nl-matcher
Attention: @nut-tree/nl-matcher
is only available to sponsors of nut.js.
In case you want to get access to it, please consult the sponsoring profile
Next Level module for image search.
Comes with additional features compared to @nut-tree/template-matcher
:
screen.findAll(...)
to detect multiple instances of an image on screen@nut-tree/template-matcher
1hyperfine --warmup 3 'node template-matcher.js' 'node nl-matcher.js' --show-output 2Benchmark 1: node template-matcher.js 3 Time (mean ± σ): 1.575 s ± 0.016 s [User: 1.469 s, System: 0.225 s] 4 Range (min … max): 1.545 s … 1.590 s 10 runs 5 6Benchmark 2: node nl-matcher.js 7 Time (mean ± σ): 917.3 ms ± 11.1 ms [User: 1616.6 ms, System: 388.0 ms] 8 Range (min … max): 899.7 ms … 930.7 ms 10 runs 9 10Summary 11 'node nl-matcher.js' ran 12 1.72 ± 0.03 times faster than 'node template-matcher.js'
Simply require / import the package to wire up the provider:
1const { screen, imageResource } = require("@nut-tree/nut-js"); 2require("@nut-tree/nl-matcher"); 3 4(async () => { 5 const img = await screen.findAll(imageResource("...")); 6})();
@nut-tree/nl-matcher
takes an optional configuration object passed to it via MatchRequest#providerData property.
1export interface NlMatcherProviderData { 2 searchMultipleScales: boolean; // default: true 3}
1const {screen, imageResource} = require("@nut-tree/nut-js"); 2require("@nut-tree/nl-matcher"); 3 4(async () => { 5 const img = await screen.findAll(imageResource("..."), { 6 providerData: { 7 searchMultipleScales: false 8 } 9 }); 10})();
© 2023