Contents

---
title: Wayfarer::Base
---

# `Wayfarer::Base`

Wayfarer's complete job API.

---

### `::route`
:   Draw routes to instance methods.

---

### `::steer { (Wayfarer::Task) -> [any] }`
:   Provide router arguments.

---

### `#task -> Wayfarer::Task`
:   The currently processing task.

---

### `#params -> Hash`
:   URL parameters collected from the matching route.

---

### `#stage(String | [String]) -> void`
:   Add URLs to a processing set. URLs already processed within the
    current batch get discarded are not enqueued. Every staged URL gets
    normalized.

---

### `#browser -> Object`
:   The user agent that retrieved the current page.

---

### `#page(live: true | false) -> Page`
:   The page representing the response retrieved from the currently
    processing URL.

    With `live: true` called, a fresh `Page` is returned that reflects the
    current browser DOM. Calls to `#page` return the most recent page.

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
wayfarer-0.4.6	docs/reference/api/base.md
wayfarer-0.4.5	docs/reference/api/base.md
wayfarer-0.4.4	docs/reference/api/base.md
wayfarer-0.4.3	docs/reference/api/base.md
wayfarer-0.4.2	docs/reference/api/base.md