Skip to content

Commit f0cf782

Browse files
committed
(#87) LocationParameters API docs
1 parent ddc676b commit f0cf782

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Diff for: lib/locationparameters.class.ts

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
import { Region } from "./region.class";
22

3+
/**
4+
* {@link LocationParameters} serves as a data class holding location parameters for image search
5+
*/
36
export class LocationParameters {
7+
/**
8+
* {@link LocationParameters} class constructor
9+
* @param searchRegion Optional {@link Region} to limit the search space to
10+
* @param confidence Optional confidence value to configure image match confidence
11+
*/
412
constructor(public searchRegion?: Region, public confidence?: number) {}
513
}

0 commit comments

Comments
 (0)