node_two_captcha_fork_emd
Version:
Node.js package for easy integration with 2Captcha API (Captcha Solver as a Service)
586 lines (124 loc) • 5.85 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Captcha</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Captcha</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Captcha<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Represents a captcha</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Captcha"><span class="type-signature"></span>new Captcha<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="captcha.js.html">captcha.js</a>, <a href="captcha.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="apiResponse"><span class="type-signature"></span>apiResponse<span class="type-signature"></span></h4>
<div class="description">
API response for captcha request
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="captcha.js.html">captcha.js</a>, <a href="captcha.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"></span></h4>
<div class="description">
Captcha ID, as provided from 2Captcha
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="captcha.js.html">captcha.js</a>, <a href="captcha.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h4 class="name" id="text"><span class="type-signature"></span>text<span class="type-signature"></span></h4>
<div class="description">
Text from captcha
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="captcha.js.html">captcha.js</a>, <a href="captcha.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="coordinates"><span class="type-signature"></span>coordinates<span class="signature">()</span><span class="type-signature"> → {Array.<Array.<Number>>}</span></h4>
<div class="description">
If the captcha sent was a image, this function returns the coordinates
(X, Y) clicked
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="captcha.js.html">captcha.js</a>, <a href="captcha.js.html#line64">line 64</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
An array of coordinate tuples
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Array.<Number>></span>
</dd>
</dl>
<h4 class="name" id="indexes"><span class="type-signature"></span>indexes<span class="signature">()</span><span class="type-signature"> → {Array.<Number>}</span></h4>
<div class="description">
If the captcha sent was tile-like, this function returns the indexes of the
clicks on an array.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="captcha.js.html">captcha.js</a>, <a href="captcha.js.html#line54">line 54</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
An array of indexes clicked
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<Number></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Captcha.html">Captcha</a></li><li><a href="HTTPRequest.html">HTTPRequest</a></li><li><a href="TwoCaptchaClient.html">TwoCaptchaClient</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Mon May 17 2021 19:14:49 GMT-0300 (Brasilia Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>