Search
Preparing search index...
The search index is not available
source-scraper-dom-runner
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Globals
SimpleDomScraper
Class SimpleDomScraper<SO>
Type parameters
SO
:
IRunnerScraperOptions
<
RO
>
Hierarchy
SourceRunnerScraper
<
ISimpleDomScraperSourceData
,
IDomRunnerOptions
,
IDomRunnerArgs
,
DomRunner
<
ISimpleDomScraperSourceData
>
>
SimpleDomScraper
Implements
IConfigurable
<
SO
>
IScraper
<
ISimpleDomScraperSourceData
,
SO
>
IRunnerScraper
<
ISimpleDomScraperSourceData
,
IDomRunnerOptions
,
IDomRunnerArgs
,
DomRunner
<
ISimpleDomScraperSourceData
>
,
SO
>
ISourceScraper
<
ISimpleDomScraperSourceData
,
SO
>
ISourceScraper
<
ISimpleDomScraperSourceData
>
Index
Properties
default
Options
domains
name
runner
url
Pattern
Methods
change
Options
exec
exec
With
Args
get
Options
get
Scrap
get
Url
Data
is
Applicable
is
Applicable
Domain
scrap
scrap
From
Args
scrap
From
Html
transform
Url
merge
Options
Properties
default
Options
default
Options
:
ISimpleDomScraperOptions
domains
domains
:
string
[]
= []
name
name
:
string
= "dom"
runner
runner
:
DomRunner
<
ISimpleDomScraperSourceData
>
= new DomRunner<ISimpleDomScraperSourceData>()
url
Pattern
url
Pattern
:
RegExp
= /.*/i
Methods
change
Options
change
Options
(
options
:
Partial
<
SO
>
)
:
SO
Parameters
options:
Partial
<
SO
>
Returns
SO
Protected
exec
exec
(
url
:
string
, options
:
SO
)
:
Promise
<
ISimpleDomScraperSourceData
>
Parameters
url:
string
options:
SO
Returns
Promise
<
ISimpleDomScraperSourceData
>
Protected
exec
With
Args
exec
With
Args
(
__namedParameters
:
object
)
:
Promise
<
ISimpleDomScraperSourceData
>
Parameters
__namedParameters:
object
document
:
Document
Returns
Promise
<
ISimpleDomScraperSourceData
>
get
Options
get
Options
(
options
?:
Partial
<
SO
>
)
:
SO
Parameters
Optional
options:
Partial
<
SO
>
Returns
SO
Protected
get
Scrap
get
Scrap
(
url
:
string
, dataSupplier
:
function
)
:
Promise
<
Scrap
<
ISimpleDomScraperSourceData
>
>
Parameters
url:
string
dataSupplier:
function
(
)
:
Promise
<
ISimpleDomScraperSourceData
>
Returns
Promise
<
ISimpleDomScraperSourceData
>
Returns
Promise
<
Scrap
<
ISimpleDomScraperSourceData
>
>
get
Url
Data
get
Url
Data
(
url
:
string
, throwIfNull
:
true
)
:
RegExpExecArray
get
Url
Data
(
url
:
string
, throwIfNull
:
false
)
:
RegExpExecArray
|
null
Parameters
url:
string
throwIfNull:
true
Returns
RegExpExecArray
Parameters
url:
string
throwIfNull:
false
Returns
RegExpExecArray
|
null
is
Applicable
is
Applicable
(
url
:
string
)
:
boolean
Parameters
url:
string
Returns
boolean
is
Applicable
Domain
is
Applicable
Domain
(
domain
:
string
)
:
boolean
Parameters
domain:
string
Returns
boolean
scrap
scrap
(
url
:
string
, options
?:
SO
)
:
Promise
<
Scrap
<
ISimpleDomScraperSourceData
>
>
Parameters
url:
string
Optional
options:
SO
Returns
Promise
<
Scrap
<
ISimpleDomScraperSourceData
>
>
scrap
From
Args
scrap
From
Args
(
args
:
IDomRunnerArgs
, options
?:
SO
)
:
Promise
<
Scrap
<
ISimpleDomScraperSourceData
>
>
Parameters
args:
IDomRunnerArgs
Optional
options:
SO
Returns
Promise
<
Scrap
<
ISimpleDomScraperSourceData
>
>
scrap
From
Html
scrap
From
Html
(
url
:
string
, html
:
string
, jsdomOptions
?:
JSDOMOptions
, options
?:
ISimpleDomScraperOptions
)
:
Promise
<
Scrap
<
ISimpleDomScraperSourceData
>
>
Parameters
url:
string
html:
string
Optional
jsdomOptions:
JSDOMOptions
Optional
options:
ISimpleDomScraperOptions
Returns
Promise
<
Scrap
<
ISimpleDomScraperSourceData
>
>
Protected
Optional
transform
Url
transform
Url
(
url
:
string
)
:
string
Parameters
url:
string
Returns
string
Static
merge
Options
merge
Options<O>
(
o1
:
O
, o2
:
Partial
<
O
>
|
O
|
undefined
)
:
O
merge
Options<O>
(
o1
:
O
|
Partial
<
O
>
|
undefined
, o2
:
O
)
:
O
merge
Options<O>
(
o1
:
Partial
<
O
>
|
undefined
, o2
:
Partial
<
O
>
)
:
Partial
<
O
>
merge
Options<O>
(
o1
:
Partial
<
O
>
, o2
:
Partial
<
O
>
|
undefined
)
:
Partial
<
O
>
merge
Options<O>
(
o1
:
Partial
<
O
>
|
undefined
, o2
:
Partial
<
O
>
|
undefined
)
:
Partial
<
O
>
|
undefined
Type parameters
O
:
IOptions
Parameters
o1:
O
o2:
Partial
<
O
>
|
O
|
undefined
Returns
O
Type parameters
O
:
IOptions
Parameters
o1:
O
|
Partial
<
O
>
|
undefined
o2:
O
Returns
O
Type parameters
O
:
IOptions
Parameters
o1:
Partial
<
O
>
|
undefined
o2:
Partial
<
O
>
Returns
Partial
<
O
>
Type parameters
O
:
IOptions
Parameters
o1:
Partial
<
O
>
o2:
Partial
<
O
>
|
undefined
Returns
Partial
<
O
>
Type parameters
O
:
IOptions
Parameters
o1:
Partial
<
O
>
|
undefined
o2:
Partial
<
O
>
|
undefined
Returns
Partial
<
O
>
|
undefined
Globals
Dom
Runner
Simple
Dom
Scraper
default
Options
domains
name
runner
url
Pattern
change
Options
exec
exec
With
Args
get
Options
get
Scrap
get
Url
Data
is
Applicable
is
Applicable
Domain
scrap
scrap
From
Args
scrap
From
Html
transform
Url
merge
Options
IDom
Runner
IDom
Runner
Args
IDom
Runner
Options
ISimple
Dom
Scraper
Options
ISimple
Dom
Scraper
Source
Data
Generated using
TypeDoc