@ourstreets/plate-lookup-etimspayments

API

Table of Contents

• EtimspaymentsLookup
  • Parameters
  • initialize
  • teardown
  • lookup
    • Parameters
• screenshotDOMElement
  • Parameters

EtimspaymentsLookup

Lookup service class for municipalities using etimspayments.

Uses Puppeteer and Tesseract.js to load etimspayments powered ticket payments systems to get unpaid citations.

Parameters

• url string The URL of the etimspayments instance
• browser object? Puppeeteer browser instance
• tesseractWorker object? Tesseract worker instance

initialize

Initialize the browser and tesseractWorker if needed

teardown

Close the puppeteer browser and terminate the tesseractWorker

lookup

Lookup a plate

Parameters

• state string The state of the license plate (2 character state code)
• number string The plate numbers and letters
• options object the only option currently is the retryCaptcha key. specify an integer to retry on captcha errors
  • options.retry (optional, default 0)

Returns Array<Object> An array of citation objects

screenshotDOMElement

Takes a screenshot of a DOM element on the page, with optional padding.

Parameters

• page Page pupeteer page object
• opts !{path: string, selector: string, padding: (number | undefined)}? (optional, default {})

Returns <>