# the-crawler-base@2.1.2

Base of the-crawlers

+ Functions
  + [create(args)](#the-crawler-base-function-create)
  + [resourceMix(BaseClass)](#the-crawler-base-function-resource-mix)
+ [`TheCrwl`](#the-crawler-base-classes) Class
  + [new TheCrwl()](#the-crawler-base-classes-the-crwl-constructor)
  + [crwl.crawl(config)](#the-crawler-base-classes-the-crwl-crawl)
  + [crwl.run(config)](#the-crawler-base-classes-the-crwl-run)
  + [crwl.crawl(config)](#the-crawler-base-classes-the-crwl-crawl)
  + [crwl.run(config)](#the-crawler-base-classes-the-crwl-run)

## Functions

<a class='md-heading-link' name="the-crawler-base-function-create" ></a>

### create(args) -> `TheCrwl`

Create a TheCrwl instance

| Param | Type | Description |
| ----- | --- | -------- |
| args | * |  |

<a class='md-heading-link' name="the-crawler-base-function-resource-mix" ></a>

### resourceMix(BaseClass) -> `function`

Mix up resource

| Param | Type | Description |
| ----- | --- | -------- |
| BaseClass | function | Base class |



<a class='md-heading-link' name="the-crawler-base-classes"></a>

## `TheCrwl` Class

Base crawler class




<a class='md-heading-link' name="the-crawler-base-classes-the-crwl-constructor" ></a>

### new TheCrwl()

Constructor of TheCrwl class



<a class='md-heading-link' name="the-crawler-base-classes-the-crwl-crawl" ></a>

### crwl.crawl(config) -> `Promise.<Array>`

Do crawl

| Param | Type | Description |
| ----- | --- | -------- |
| config | Object | Crawl config |


<a class='md-heading-link' name="the-crawler-base-classes-the-crwl-run" ></a>

### crwl.run(config) -> `Promise.<void>`

Run the crawler

| Param | Type | Description |
| ----- | --- | -------- |
| config | Object | Crawl config |


<a class='md-heading-link' name="the-crawler-base-classes-the-crwl-crawl" ></a>

### crwl.crawl(config) -> `Promise.<Array>`

Do crawl

| Param | Type | Description |
| ----- | --- | -------- |
| config | Object | Crawl config |


<a class='md-heading-link' name="the-crawler-base-classes-the-crwl-run" ></a>

### crwl.run(config) -> `Promise.<void>`

Run the crawler

| Param | Type | Description |
| ----- | --- | -------- |
| config | Object | Crawl config |