Class Crawler

Hierarchy

EventEmitter
- Crawler

Index

Constructors

constructor

new Crawler(options?: Partial<CrawlerOptions>): Crawler
Parameters
- Optional options: Partial<CrawlerOptions>
Returns Crawler
Overrides EventEmitter.constructor
- Defined in packages/crawler/src/crawler.ts:13

Properties

`Protected` _browser

_browser: null | Promise<Browser> = null

`Protected` options

options: CrawlerOptions

`Static` prefixed

prefixed: string | boolean

Accessors

`Protected` browser

get browser(): Promise<Browser>
Returns Promise<Browser>
- Defined in packages/crawler/src/crawler.ts:126

Methods

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): Crawler
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns Crawler
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:45

emit

emit(event: "page-start", data: {
    page: Page;
    path: string[];
    url: string;
}): boolean
Parameters
- event: "page-start"
- data: {
      page: Page;
      path: string[];
      url: string;
  }
  - page: Page
  - path: string[]
  - url: string
Returns boolean
Overrides EventEmitter.emit
- Defined in packages/crawler/src/crawler.ts:195
emit(event: "page-done", data: {
    page: Page;
    path: string[];
    url: string;
}): boolean
Parameters
- event: "page-done"
- data: {
      page: Page;
      path: string[];
      url: string;
  }
  - page: Page
  - path: string[]
  - url: string
Returns boolean
Overrides EventEmitter.emit
- Defined in packages/crawler/src/crawler.ts:196
emit(event: "actor-triggered", data: {
    actor: string;
    page: Page;
    path: string[];
    url: string;
}): boolean
Parameters
- event: "actor-triggered"
- data: {
      actor: string;
      page: Page;
      path: string[];
      url: string;
  }
  - actor: string
  - page: Page
  - path: string[]
  - url: string
Returns boolean
Overrides EventEmitter.emit
- Defined in packages/crawler/src/crawler.ts:197
emit(event: "warning", err: Error): boolean
Parameters
- event: "warning"
- err: Error
Returns boolean
Overrides EventEmitter.emit
- Defined in packages/crawler/src/crawler.ts:201

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:20

off

off(event: "page-start", listener: ((data: {
    page: Page;
    path: string[];
    url: string;
}) => void)): Crawler
Parameters
- event: "page-start"
- listener: ((data: {
      page: Page;
      path: string[];
      url: string;
  }) => void)
  - - (data: {
          page: Page;
          path: string[];
          url: string;
      }): void
    - Parameters
      
      data: {
          page: Page;
          path: string[];
          url: string;
      }
      
      page: Page
      
      path: string[]
      
      url: string
      
      Returns void
Returns Crawler
Overrides EventEmitter.off
- Defined in packages/crawler/src/crawler.ts:178
off(event: "page-done", listener: ((data: {
    page: Page;
    path: string[];
    url: string;
}) => void)): Crawler
Parameters
- event: "page-done"
- listener: ((data: {
      page: Page;
      path: string[];
      url: string;
  }) => void)
  - - (data: {
          page: Page;
          path: string[];
          url: string;
      }): void
    - Parameters
      
      data: {
          page: Page;
          path: string[];
          url: string;
      }
      
      page: Page
      
      path: string[]
      
      url: string
      
      Returns void
Returns Crawler
Overrides EventEmitter.off
- Defined in packages/crawler/src/crawler.ts:182
off(event: "actor-triggered", listener: ((data: {
    actor: string;
    page: Page;
    path: string[];
    url: string;
}) => void)): Crawler
Parameters
- event: "actor-triggered"
- listener: ((data: {
      actor: string;
      page: Page;
      path: string[];
      url: string;
  }) => void)
  - - (data: {
          actor: string;
          page: Page;
          path: string[];
          url: string;
      }): void
    - Parameters
      
      data: {
          actor: string;
          page: Page;
          path: string[];
          url: string;
      }
      
      actor: string
      
      page: Page
      
      path: string[]
      
      url: string
      
      Returns void
Returns Crawler
Overrides EventEmitter.off
- Defined in packages/crawler/src/crawler.ts:186
off(event: "warning", listener: ((err: Error) => void)): Crawler
Parameters
- event: "warning"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      
      err: Error
      
      Returns void
Returns Crawler
Overrides EventEmitter.off
- Defined in packages/crawler/src/crawler.ts:190

on

on(event: "page-start", listener: ((data: {
    page: Page;
    path: string[];
    url: string;
}) => void)): Crawler
Parameters
- event: "page-start"
- listener: ((data: {
      page: Page;
      path: string[];
      url: string;
  }) => void)
  - - (data: {
          page: Page;
          path: string[];
          url: string;
      }): void
    - Parameters
      
      data: {
          page: Page;
          path: string[];
          url: string;
      }
      
      page: Page
      
      path: string[]
      
      url: string
      
      Returns void
Returns Crawler
Overrides EventEmitter.on
- Defined in packages/crawler/src/crawler.ts:144
on(event: "page-done", listener: ((data: {
    page: Page;
    path: string[];
    url: string;
}) => void)): Crawler
Parameters
- event: "page-done"
- listener: ((data: {
      page: Page;
      path: string[];
      url: string;
  }) => void)
  - - (data: {
          page: Page;
          path: string[];
          url: string;
      }): void
    - Parameters
      
      data: {
          page: Page;
          path: string[];
          url: string;
      }
      
      page: Page
      
      path: string[]
      
      url: string
      
      Returns void
Returns Crawler
Overrides EventEmitter.on
- Defined in packages/crawler/src/crawler.ts:148
on(event: "actor-triggered", listener: ((data: {
    actor: string;
    page: Page;
    path: string[];
    url: string;
}) => void)): Crawler
Parameters
- event: "actor-triggered"
- listener: ((data: {
      actor: string;
      page: Page;
      path: string[];
      url: string;
  }) => void)
  - - (data: {
          actor: string;
          page: Page;
          path: string[];
          url: string;
      }): void
    - Parameters
      
      data: {
          actor: string;
          page: Page;
          path: string[];
          url: string;
      }
      
      actor: string
      
      page: Page
      
      path: string[]
      
      url: string
      
      Returns void
Returns Crawler
Overrides EventEmitter.on
- Defined in packages/crawler/src/crawler.ts:152
on(event: "warning", listener: ((err: Error) => void)): Crawler
Parameters
- event: "warning"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      
      err: Error
      
      Returns void
Returns Crawler
Overrides EventEmitter.on
- Defined in packages/crawler/src/crawler.ts:156

once

once(event: "page-start", listener: ((data: {
    page: Page;
    path: string[];
    url: string;
}) => void)): Crawler
Parameters
- event: "page-start"
- listener: ((data: {
      page: Page;
      path: string[];
      url: string;
  }) => void)
  - - (data: {
          page: Page;
          path: string[];
          url: string;
      }): void
    - Parameters
      
      data: {
          page: Page;
          path: string[];
          url: string;
      }
      
      page: Page
      
      path: string[]
      
      url: string
      
      Returns void
Returns Crawler
Overrides EventEmitter.once
- Defined in packages/crawler/src/crawler.ts:161
once(event: "page-done", listener: ((data: {
    page: Page;
    path: string[];
    url: string;
}) => void)): Crawler
Parameters
- event: "page-done"
- listener: ((data: {
      page: Page;
      path: string[];
      url: string;
  }) => void)
  - - (data: {
          page: Page;
          path: string[];
          url: string;
      }): void
    - Parameters
      
      data: {
          page: Page;
          path: string[];
          url: string;
      }
      
      page: Page
      
      path: string[]
      
      url: string
      
      Returns void
Returns Crawler
Overrides EventEmitter.once
- Defined in packages/crawler/src/crawler.ts:165
once(event: "actor-triggered", listener: ((data: {
    actor: string;
    page: Page;
    path: string[];
    url: string;
}) => void)): Crawler
Parameters
- event: "actor-triggered"
- listener: ((data: {
      actor: string;
      page: Page;
      path: string[];
      url: string;
  }) => void)
  - - (data: {
          actor: string;
          page: Page;
          path: string[];
          url: string;
      }): void
    - Parameters
      
      data: {
          actor: string;
          page: Page;
          path: string[];
          url: string;
      }
      
      actor: string
      
      page: Page
      
      path: string[]
      
      url: string
      
      Returns void
Returns Crawler
Overrides EventEmitter.once
- Defined in packages/crawler/src/crawler.ts:169
once(event: "warning", listener: ((err: Error) => void)): Crawler
Parameters
- event: "warning"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      
      err: Error
      
      Returns void
Returns Crawler
Overrides EventEmitter.once
- Defined in packages/crawler/src/crawler.ts:173

removeAllListeners

removeAllListeners(event?: string | symbol): Crawler
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns Crawler
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): Crawler
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Crawler
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:63

start

start<A>(strategy: CrawlerStrategy<A>): Promise<CrawlerResult<A>>
Type Parameters
- A extends {
  [key: string]: CrawlerActor<unknown>;
  }
Parameters
- strategy: CrawlerStrategy<A>
Returns Promise<CrawlerResult<A>>
- Defined in packages/crawler/src/crawler.ts:22

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in packages/crawler/src/crawler.ts:136

Class Crawler

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: Partial<CrawlerOptions>

Returns Crawler

Properties

Protected _browser

Protected options

Static prefixed

Accessors

Protected browser

Returns Promise<Browser>

Methods

addListener

Type Parameters

T extends string | symbol

Parameters

event: T

fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns Crawler

emit

Parameters

event: "page-start"

data: { page: Page; path: string[]; url: string; }

page: Page

path: string[]

url: string

Returns boolean

Parameters

event: "page-done"

data: { page: Page; path: string[]; url: string; }

page: Page

path: string[]

url: string

Returns boolean

Parameters

event: "actor-triggered"

data: { actor: string; page: Page; path: string[]; url: string; }

actor: string

page: Page

path: string[]

url: string

Returns boolean

Parameters

event: "warning"

err: Error

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Type Parameters

T extends string | symbol

Parameters

event: T

Returns ((...args: any[]) => void)[]

off

Parameters

event: "page-start"

listener: ((data: { page: Page; path: string[]; url: string; }) => void)

Parameters

data: { page: Page; path: string[]; url: string; }

page: Page

path: string[]

url: string

Returns void

`Optional` options: Partial<CrawlerOptions>

`Protected` _browser

`Protected` options

`Static` prefixed

`Protected` browser

`Rest` ...args: any[]

`Optional` context: any

data: {
page: Page;
path: string[];
url: string;
}

data: {
page: Page;
path: string[];
url: string;
}

data: {
actor: string;
page: Page;
path: string[];
url: string;
}

listener: ((data: {
page: Page;
path: string[];
url: string;
}) => void)

data: {
page: Page;
path: string[];
url: string;
}

listener: ((data: {
page: Page;
path: string[];
url: string;
}) => void)

data: {
page: Page;
path: string[];
url: string;
}

listener: ((data: {
actor: string;
page: Page;
path: string[];
url: string;
}) => void)

data: {
actor: string;
page: Page;
path: string[];
url: string;
}

listener: ((data: {
page: Page;
path: string[];
url: string;
}) => void)

data: {
page: Page;
path: string[];
url: string;
}

listener: ((data: {
page: Page;
path: string[];
url: string;
}) => void)

data: {
page: Page;
path: string[];
url: string;
}

listener: ((data: {
actor: string;
page: Page;
path: string[];
url: string;
}) => void)

data: {
actor: string;
page: Page;
path: string[];
url: string;
}