kopia lustrzana https://github.com/harvard-lil/archive.social
Doc update
Matteo Cargnelutti
rodzic
de8d6f1038
commit
a565fd4d05
|
|
@ -15,6 +15,7 @@ thread-keeper
|
|||
* [.STATIC_PATH](#module_const.STATIC_PATH)
|
||||
* [.MAX_PARALLEL_CAPTURES_TOTAL](#module_const.MAX_PARALLEL_CAPTURES_TOTAL)
|
||||
* [.MAX_PARALLEL_CAPTURES_PER_ACCESS_KEY](#module_const.MAX_PARALLEL_CAPTURES_PER_ACCESS_KEY)
|
||||
* [.APP_VERSION](#module_const.APP_VERSION)
|
||||
|
||||
<a name="module_const.CERTS_PATH"></a>
|
||||
|
||||
|
|
@ -64,3 +65,9 @@ Maximum capture processes that can be run in parallel.
|
|||
Maximum capture processes that can be run in parallel for a given key.
|
||||
|
||||
**Kind**: static constant of [<code>const</code>](#module_const)
|
||||
<a name="module_const.APP_VERSION"></a>
|
||||
|
||||
### const.APP\_VERSION
|
||||
APP version. Pulled from `package.json` by default.
|
||||
|
||||
**Kind**: static constant of [<code>const</code>](#module_const)
|
||||
|
|
|
|||
|
|
@ -7,33 +7,30 @@ thread-keeper
|
|||
**License**: MIT
|
||||
|
||||
* [TwitterCapture](#utils.module_TwitterCapture)
|
||||
* _static_
|
||||
* [.TwitterCapture](#utils.module_TwitterCapture.TwitterCapture)
|
||||
* [new exports.TwitterCapture(url, options)](#new_utils.module_TwitterCapture.TwitterCapture_new)
|
||||
* [.defaults](#utils.module_TwitterCapture.TwitterCapture+defaults)
|
||||
* [.options](#utils.module_TwitterCapture.TwitterCapture+options) : <code>object</code>
|
||||
* [.url](#utils.module_TwitterCapture.TwitterCapture+url) : <code>string</code>
|
||||
* [.urlType](#utils.module_TwitterCapture.TwitterCapture+urlType) : <code>string</code>
|
||||
* [.playwright](#utils.module_TwitterCapture.TwitterCapture+playwright) : <code>Object</code>
|
||||
* [.interceptedJPEGs](#utils.module_TwitterCapture.TwitterCapture+interceptedJPEGs) : <code>object.<string, Buffer></code>
|
||||
* [.capture](#utils.module_TwitterCapture.TwitterCapture+capture) ⇒ <code>Promise.<Buffer></code>
|
||||
* [.setup](#utils.module_TwitterCapture.TwitterCapture+setup) ⇒ <code>Promise.<void></code>
|
||||
* [.teardown](#utils.module_TwitterCapture.TwitterCapture+teardown)
|
||||
* [.adjustUIForCapture](#utils.module_TwitterCapture.TwitterCapture+adjustUIForCapture) ⇒ <code>Promise.<void></code>
|
||||
* [.runBrowserBehaviors](#utils.module_TwitterCapture.TwitterCapture+runBrowserBehaviors) ⇒ <code>Promise.<void></code>
|
||||
* [.resizeViewportToFitDocument](#utils.module_TwitterCapture.TwitterCapture+resizeViewportToFitDocument) ⇒ <code>Promise.<void></code>
|
||||
* [.getDocumentDimensions](#utils.module_TwitterCapture.TwitterCapture+getDocumentDimensions) ⇒ <code>Promise.<{width: number, height: number}></code>
|
||||
* [.interceptJpegs](#utils.module_TwitterCapture.TwitterCapture+interceptJpegs) ⇒ <code>Promise.<void></code>
|
||||
* [.generateRawPDF](#utils.module_TwitterCapture.TwitterCapture+generateRawPDF) ⇒ <code>Promise.<Buffer></code>
|
||||
* [.addInterceptedJPEGsToPDF](#utils.module_TwitterCapture.TwitterCapture+addInterceptedJPEGsToPDF) ⇒ <code>Promise.<void></code>
|
||||
* [.captureAndAddUrlMapToPDF](#utils.module_TwitterCapture.TwitterCapture+captureAndAddUrlMapToPDF) ⇒ <code>Promise.<void></code>
|
||||
* [.captureAndAddVideoToPDF](#utils.module_TwitterCapture.TwitterCapture+captureAndAddVideoToPDF) ⇒ <code>Promise.<void></code>
|
||||
* [.cropMarginsOnPDF](#utils.module_TwitterCapture.TwitterCapture+cropMarginsOnPDF)
|
||||
* [.signPDF](#utils.module_TwitterCapture.TwitterCapture+signPDF) ⇒ <code>Buffer</code>
|
||||
* [.filterOptions](#utils.module_TwitterCapture.TwitterCapture+filterOptions)
|
||||
* [.filterUrl](#utils.module_TwitterCapture.TwitterCapture+filterUrl) ⇒ <code>bool</code>
|
||||
* _inner_
|
||||
* [~URL_MAP_TEMPLATE](#utils.module_TwitterCapture..URL_MAP_TEMPLATE)
|
||||
* [.TwitterCapture](#utils.module_TwitterCapture.TwitterCapture)
|
||||
* [new exports.TwitterCapture(url, options)](#new_utils.module_TwitterCapture.TwitterCapture_new)
|
||||
* [.defaults](#utils.module_TwitterCapture.TwitterCapture+defaults)
|
||||
* [.options](#utils.module_TwitterCapture.TwitterCapture+options) : <code>object</code>
|
||||
* [.url](#utils.module_TwitterCapture.TwitterCapture+url) : <code>string</code>
|
||||
* [.urlType](#utils.module_TwitterCapture.TwitterCapture+urlType) : <code>string</code>
|
||||
* [.playwright](#utils.module_TwitterCapture.TwitterCapture+playwright) : <code>Object</code>
|
||||
* [.interceptedJPEGs](#utils.module_TwitterCapture.TwitterCapture+interceptedJPEGs) : <code>object.<string, Buffer></code>
|
||||
* [.capture](#utils.module_TwitterCapture.TwitterCapture+capture) ⇒ <code>Promise.<Buffer></code>
|
||||
* [.setup](#utils.module_TwitterCapture.TwitterCapture+setup) ⇒ <code>Promise.<void></code>
|
||||
* [.teardown](#utils.module_TwitterCapture.TwitterCapture+teardown)
|
||||
* [.adjustUIForCapture](#utils.module_TwitterCapture.TwitterCapture+adjustUIForCapture) ⇒ <code>Promise.<void></code>
|
||||
* [.runBrowserBehaviors](#utils.module_TwitterCapture.TwitterCapture+runBrowserBehaviors) ⇒ <code>Promise.<void></code>
|
||||
* [.resizeViewportToFitDocument](#utils.module_TwitterCapture.TwitterCapture+resizeViewportToFitDocument) ⇒ <code>Promise.<void></code>
|
||||
* [.getDocumentDimensions](#utils.module_TwitterCapture.TwitterCapture+getDocumentDimensions) ⇒ <code>Promise.<{width: number, height: number}></code>
|
||||
* [.interceptJpegs](#utils.module_TwitterCapture.TwitterCapture+interceptJpegs) ⇒ <code>Promise.<void></code>
|
||||
* [.generateRawPDF](#utils.module_TwitterCapture.TwitterCapture+generateRawPDF) ⇒ <code>Promise.<Buffer></code>
|
||||
* [.addInterceptedJPEGsToPDF](#utils.module_TwitterCapture.TwitterCapture+addInterceptedJPEGsToPDF) ⇒ <code>Promise.<void></code>
|
||||
* [.captureAndAddUrlMapToPDF](#utils.module_TwitterCapture.TwitterCapture+captureAndAddUrlMapToPDF) ⇒ <code>Promise.<void></code>
|
||||
* [.captureAndAddVideoToPDF](#utils.module_TwitterCapture.TwitterCapture+captureAndAddVideoToPDF) ⇒ <code>Promise.<void></code>
|
||||
* [.cropMarginsOnPDF](#utils.module_TwitterCapture.TwitterCapture+cropMarginsOnPDF)
|
||||
* [.signPDF](#utils.module_TwitterCapture.TwitterCapture+signPDF) ⇒ <code>Buffer</code>
|
||||
* [.filterOptions](#utils.module_TwitterCapture.TwitterCapture+filterOptions)
|
||||
* [.filterUrl](#utils.module_TwitterCapture.TwitterCapture+filterUrl) ⇒ <code>bool</code>
|
||||
|
||||
<a name="utils.module_TwitterCapture.TwitterCapture"></a>
|
||||
|
||||
|
|
@ -93,6 +90,7 @@ Defaults for options that can be passed to `TwitterCapture`.
|
|||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| appVersion | <code>string</code> | |
|
||||
| privateKeyPath | <code>string</code> | Path to `.pem` file containing a private key. |
|
||||
| certPath | <code>string</code> | Path to a `.pem` file containing a certificate. |
|
||||
| tmpFolderPath | <code>string</code> | Path to a folder in which temporary file can be written. |
|
||||
|
|
@ -213,7 +211,7 @@ Adds entries from `this.interceptedJPEGs`
|
|||
#### twitterCapture.captureAndAddUrlMapToPDF ⇒ <code>Promise.<void></code>
|
||||
Tries to list and resolve all the `t.co` urls on the page, and add the resulting map as an attachment.
|
||||
|
||||
Attachment filename: `url-map.html`.
|
||||
Attachment filename: `url-map.csv`.
|
||||
Playwright needs to be ready.
|
||||
|
||||
**Kind**: instance property of [<code>TwitterCapture</code>](#utils.module_TwitterCapture.TwitterCapture)
|
||||
|
|
@ -281,9 +279,3 @@ Automatically populates `this.url` and `this.urlType`.
|
|||
| --- | --- |
|
||||
| url | <code>string</code> |
|
||||
|
||||
<a name="utils.module_TwitterCapture..URL_MAP_TEMPLATE"></a>
|
||||
|
||||
### TwitterCapture~URL\_MAP\_TEMPLATE
|
||||
Nunjucks template used by `TwitterCapture.captureAndAddUrlMapToPDF`.
|
||||
|
||||
**Kind**: inner constant of [<code>TwitterCapture</code>](#utils.module_TwitterCapture)
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue