add documentation

This commit is contained in:
Simon Vieille 2020-04-15 10:34:47 +02:00
parent 229242ed11
commit 5619191a00
Signed by: deblan
GPG Key ID: 03383D15A1D31745
1 changed files with 16 additions and 16 deletions

View File

@ -31,30 +31,30 @@ With code
const scraper = require('deblan-scraper')
const options = {
url: 'https://github.com/foo/bar',
acceptAllStatus: false, // Optional
method: 'GET', // Optional
url: 'https://github.com/foo/bar',
acceptAllStatus: false, // Optional, default is `false`
method: 'GET', // Optional, default is `GET`
}
const selector = '.repository-content .numbers-summary li:nth-child(4) a'
const filters = {
tags: null,
breaks: null,
spaces: null,
trim: null,
tags: null, // Removes tags. You can specify the tags to remove (separated by comma)
breaks: null, // Removes breaks (\n, \r)
spaces: null, // Replaces 2 successive spaces by 1, except breaks
trim: null, // Strips whitespaces from the beginning and end of the value
}
scraper(
options,
selector,
filters,
function(value) {
console.log(value)
},
function(error) {
console.log(error)
}
options,
selector,
filters,
function(value) {
console.log(value)
},
function(error) {
console.log(error)
}
)
```