Class: ImageToTextTask
Hierarchy
-
CapmonsterClient↳
ImageToTextTask
Constructors
constructor
• new ImageToTextTask(clientKey): ImageToTextTask
Initialize a new ImageToText task for handling the captchas
Parameters
| Name | Type | Description |
|---|---|---|
clientKey | string | Unique key of your account |
Returns
Overrides
CapmonsterClient.constructor
Defined in
Properties
clientKey
• clientKey: string
Inherited from
CapmonsterClient.clientKey
Defined in
Methods
convertCookies
▸ convertCookies(cookies): string
Convert cookies to string
Parameters
| Name | Type | Description |
|---|---|---|
cookies | Object | Your cookies as a object |
Returns
string
Since
v0.4
Inherited from
CapmonsterClient.convertCookies
Defined in
createTask
▸ createTask(image, module?, recognizingThreshold?, _case?, numeric?, math?): Promise<number>
Create task
Parameters
| Name | Type |
|---|---|
image | string |
module? | string |
recognizingThreshold? | number |
_case? | boolean |
numeric? | number |
math? | boolean |
Returns
Promise<number>
ID of the created task
Deprecated
since v0.4 - use task & createWithTask instead
Defined in
createWithTask
▸ createWithTask(task): Promise<number>
Creates a image to text task for solving
Parameters
| Name | Type | Description |
|---|---|---|
task | Omit<IImageToTextTaskRequest, "type"> | task |
Returns
Promise<number>
ID of the created task
Since
v0.4
Defined in
getBalance
▸ getBalance(): Promise<number>
Returns
Promise<number>
Balance of your account
Inherited from
CapmonsterClient.getBalance
Defined in
getTaskResult
▸ getTaskResult(taskId): Promise<null | IImageToTextTaskResponse>
Get task result
Parameters
| Name | Type | Description |
|---|---|---|
taskId | number | Task id which returns from createWithTask function. |
Returns
Promise<null | IImageToTextTaskResponse>
Returns the solution if captcha is solved, otherwise null
Also
see joinTaskResult
Defined in
joinTaskResult
▸ joinTaskResult(taskId, timeout?): Promise<IImageToTextTaskResponse>
Get task result. This function is waits until task to be solved.
Parameters
| Name | Type | Description |
|---|---|---|
taskId | number | Task id which returns from createWithTask function. |
timeout? | number | (as seconds) Sets the timeout for the current execution of this function. |
Returns
Promise<IImageToTextTaskResponse>
Solution of the task
Throws
CapmonsterError, if task can't be solved in maximum time
Also
see getTaskResult
Defined in
prepareImageFromLink
▸ prepareImageFromLink(url): Promise<string>
Prepare image with url for task or createWithTask
Parameters
| Name | Type | Description |
|---|---|---|
url | string | External image link. Example: https://somedomain.com/captcha.png |
Returns
Promise<string>
The image as converted to base64 string
Since
v0.4
Defined in
prepareImageFromLocal
▸ prepareImageFromLocal(path): Promise<string>
Prepare image from local drive for task or createWithTask
Parameters
| Name | Type | Description |
|---|---|---|
path | string | Local image path. You should resolve the path with path.resolve before passing the parameter.. |
Returns
Promise<string>
The image as converted to base64 string
Since
v0.4
Defined in
setCallbackUrl
▸ setCallbackUrl(url): void
Sets the callback url for all tasks, globally.
Contents are sent by POST request and are same to the contents. of getTaskResult method. The content of the response is not checked and you must accept the request in 2 seconds then the connection will be closed.
Parameters
| Name | Type | Description |
|---|---|---|
url | string | Web address where we will send result of captcha task processing. |
Returns
void
Inherited from
CapmonsterClient.setCallbackUrl
Defined in
setTimeout
▸ setTimeout(timeout): void
Sets the timeout for the entire client.
Parameters
| Name | Type | Description |
|---|---|---|
timeout | number | As seconds, must between 1 and 300. |
Returns
void
Inherited from
CapmonsterClient.setTimeout
Defined in
task
▸ task(task): Omit<IImageToTextTaskRequest, "type">
Creates only the task configuration for reuseable tasks.
Parameters
| Name | Type | Description |
|---|---|---|
task | Omit<IImageToTextTaskRequest, "type"> | IImageToTextTaskRequest |
Returns
Omit<IImageToTextTaskRequest, "type">
Only the task you created IImageToTextTaskRequest
Since
v0.4
Defined in
unsetCallbackUrl
▸ unsetCallbackUrl(): void
Unset the callback url for all tasks, globally.
Returns
void
Inherited from
CapmonsterClient.unsetCallbackUrl