# the-crawler-base

> Base of the-crawlers

Latest version **2.1.2** (published 2017-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install the-crawler-base
pnpm add the-crawler-base
yarn add the-crawler-base
bun add the-crawler-base
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.2 |
| Published | 2017-06-11 |
| First published | 2017-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=7.6 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | the |

## Links

- npm: https://www.npmjs.com/package/the-crawler-base
- Repository: https://github.com/the-labo/the-crawler-base
- Homepage: https://github.com/the-labo/the-crawler-base#readme
- Issues: https://github.com/the-labo/the-crawler-base/issues
- npm.io page: https://npm.io/package/the-crawler-base

## Dependencies (4)

- [argx](https://npm.io/package/argx.md) ^3.0.2
- [debug](https://npm.io/package/debug.md) ^2.6.8
- [the-check](https://npm.io/package/the-check.md) ^1.1.0
- [clay-resource-ref](https://npm.io/package/clay-resource-ref.md) ^2.0.2

## Alternatives

- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 2.1.2 (latest) — 2017-06-11
- 2.1.1 — 2017-06-11
- 2.1.0 — 2017-06-11
- 2.0.2 — 2017-06-10
- 2.0.1 — 2017-05-26
- 2.0.0 — 2017-05-26
- 1.1.0 — 2017-05-26
- 1.0.0 — 2017-05-21

## README

the-crawler-base
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/the-labo/the-crawler-base
[bd_travis_url]: http://travis-ci.org/the-labo/the-crawler-base
[bd_travis_shield_url]: http://img.shields.io/travis/the-labo/the-crawler-base.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/the-labo/the-crawler-base
[bd_travis_com_shield_url]: https://api.travis-ci.com/the-labo/the-crawler-base.svg?token=
[bd_license_url]: https://github.com/the-labo/the-crawler-base/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/the-labo/the-crawler-base
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/the-labo/the-crawler-base.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/the-labo/the-crawler-base.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/the-labo/the-crawler-base
[bd_gemnasium_shield_url]: https://gemnasium.com/the-labo/the-crawler-base.svg
[bd_npm_url]: http://www.npmjs.org/package/the-crawler-base
[bd_npm_shield_url]: http://img.shields.io/npm/v/the-crawler-base.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Base of the-crawlers

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install the-crawler-base --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const { TheCrwl } = require('the-crawler-base')
const theDB = require('the-db')

async function tryExample () {
  let db = theDB({ /* ... */ })

  class MyCrwl extends TheCrwl {
    async crawl (config = {}) {
      /* ... */
      return [
        { resource: 'Site', id: 1, attributes: { /* ... */ } },
        { resource: 'Article', id: 1, attributes: { /* ... */ } }
      ]
    }
  }

  let crwl = new MyCrwl({})
  crwl.setResource('Site', db.resource('Site'))
  crwl.setResource('Article', db.resource('Article'))

  /* ... */
}

tryExample().catch((err) => console.error(err))

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/10.API Guide.md.hbs" Start -->

<a name="section-doc-guides-10-a-p-i-guide-md"></a>

API Guide
-----

+ [the-crawler-base@2.1.2](./doc/api/api.md)
  + [create(args)](./doc/api/api.md#the-crawler-base-function-create)


<!-- Section from "doc/guides/10.API Guide.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the-crawler-base/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][t_h_e_labo_url]

[t_h_e_labo_url]: https://github.com/the-labo

<!-- Links End -->

---
_Source: https://npm.io/package/the-crawler-base · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
