Skip to content

API.md

Latest commit

 

History

History
128 lines (78 loc) · 4.84 KB

API.md

File metadata and controls

128 lines (78 loc) · 4.84 KB
Raw

WebReaper

Contents

BrowserPageLoader type

Namespace

WebReaper.Core.Loaders.Abstract

Summary

Base class for implementing a browser page loader

#ctor(logger) constructor

Summary

Constructor that takes ILogger argument

Parameters
Name Type Description
logger Microsoft.Extensions.Logging.ILogger

PageActions constants

Summary

Interactive browser actions that can be performed on the page

Logger property

Summary

Logger

ConfigBuilder type

Namespace

WebReaper.Builders

Get(startUrls) method

Summary

This method can be called only one time to specify urls to start crawling with.

Returns

instance of ConfigBuilder

Parameters
Name Type Description
startUrls System.String[] Initial urls for crawling

GetWithBrowser(startUrls,pageActions) method

Summary

This method can be called only one time to specify urls to start crawling with.

Returns

instance of ConfigBuilder

Parameters
Name Type Description
startUrls System.Collections.Generic.IEnumerable{System.String} Initial urls for crawling
pageActions System.Collections.Generic.List{WebReaper.Domain.PageActions.PageAction} Actions to perform on the page via a browser

FileScraperConfigStorage type

Namespace

WebReaper.ConfigStorage.Concrete

Summary

Inherit from parent.

InMemoryCookieStorage type

Namespace

WebReaper.Core.CookieStorage.Concrete

Summary

Inherit from parent.

ScraperEngineBuilder type

Namespace

WebReaper.Builders

Summary

Builds a web scraper engine responsible for creating and receiving crawling jobs and running a spider on them