Toppokki

data Puppeteer

data Browser

data Page

data ElementHandle

data ConsoleMessage

data ChromeAWS

newtype URL

Constructors

• URL String

Instances

• Newtype URL _

newtype Selector

Constructors

• Selector String

Instances

• Newtype Selector _

type LaunchOptions :: Row Typetype LaunchOptions = (args :: Array String, defaultViewport :: Record DefaultViewPort, devtools :: Boolean, dumpio :: Boolean, executablePath :: String, handleSIGHUP :: Boolean, handleSIGINT :: Boolean, handleSIGTERM :: Boolean, headless :: Boolean, ignoreDefaultArgs :: Array String, ignoreHTTPSErrors :: Boolean, pipe :: Boolean, slowMo :: Number, timeout :: Number, userDataDir :: String)

type DefaultViewPort :: Row Typetype DefaultViewPort = (deviceScaleFactor :: Number, hasTouch :: Boolean, height :: Number, isLandscape :: Boolean, isMobile :: Boolean, width :: Number)

launch :: forall options trash. Union options trash LaunchOptions => Record options -> Aff Browser

launchChromeAWS :: forall options trash. Union options trash LaunchOptions => ChromeAWS -> Record options -> Aff Browser

newPage :: Browser -> Aff Page

pages :: Browser -> Aff (Array Page)

goto :: URL -> Page -> Aff Unit

close :: Browser -> Aff Unit

content :: Page -> Aff String

type ScreenshotOptions :: Row Typetype ScreenshotOptions = (clip :: { height :: Int, width :: Int, x :: Int, y :: Int }, fullPage :: Boolean, omitBackground :: Boolean, path :: String, quality :: Int, type :: String)

screenshot :: forall options trash. Union options trash ScreenshotOptions => Record options -> Page -> Aff Buffer

data PDFMargin

type PDFMarginOptions :: Row Typetype PDFMarginOptions = (bottom :: String, left :: String, right :: String, top :: String)

makePDFMargin :: forall options trash. Union options trash PDFMarginOptions => Record options -> PDFMargin

type PDFOptions :: Row Typetype PDFOptions = (displayHeaderFooter :: Boolean, footerTemplate :: String, format :: String, headerTemplate :: String, height :: String, landscape :: Boolean, margin :: PDFMargin, pageRanges :: String, path :: String, printBackground :: Boolean, scale :: Int, width :: String)

pdf :: forall options trash. Union options trash PDFOptions => Record options -> Page -> Aff Buffer

onPageError :: EffectFn1 Error Unit -> Page -> Effect Unit

onLoad :: EffectFn1 Unit Unit -> Page -> Effect Unit

onConsole :: EffectFn1 ConsoleMessage Unit -> Page -> Effect Unit

onRequestFailed :: EffectFn1 Error Unit -> Page -> Effect Unit

pageWaitForSelector :: forall options trash. Union options trash (hidden :: Boolean, timeout :: Int, visible :: Boolean) => Selector -> Record options -> Page -> Aff ElementHandle

focus :: Selector -> Page -> Aff Unit

select :: Selector -> String -> Page -> Aff Unit

Select a specific option in select dropdown group.

type_ :: forall options trash. Union options trash (delay :: Int) => Selector -> String -> Record options -> Page -> Aff Unit

click :: Selector -> Page -> Aff Unit

data WaitUntilOption

networkIdle :: WaitUntilOption

networkIdle0 :: WaitUntilOption

networkIdle2 :: WaitUntilOption

waitForNavigation :: forall options trash. Union options trash (waitUntil :: WaitUntilOption) => Record options -> Page -> Aff Unit

getLocationRef :: Page -> Aff String

unsafeEvaluateOnNewDocument :: String -> Page -> Aff Foreign

The function is invoked after the document was created but before any of its scripts were run.

This is useful to amend the environment, e.g. to seed Math.random.

unsafeEvaluateStringFunction :: String -> Page -> Aff Foreign

unsafePageEval :: Selector -> String -> Page -> Aff Foreign

This method runs document.querySelector within the page and passes it as the first argument to pageFunction. If there's no element matching selector, the method throws an error.

Second argument is a pageFunction which should be a valid JavaScript function written as a string which we unsafely eval.

If pageFunction returns a Promise, then page.$$eval would wait for the promise to resolve and return its value.

unsafePageEvalAll :: Selector -> String -> Page -> Aff Foreign

This method runs Array.from(document.querySelectorAll(selector)) within the page and passes it as the first argument to pageFunction.

Second argument is a pageFunction which should be a valid JavaScript function written as a string which we unsafely eval.

If pageFunction returns a Promise, then page.$$eval would wait for the promise to resolve and return its value.

runPromiseAffE1 :: forall a o. Fn1 a (Effect (Promise o)) -> a -> Aff o

runPromiseAffE2 :: forall a b o. Fn2 a b (Effect (Promise o)) -> a -> b -> Aff o

runPromiseAffE3 :: forall a b c o. Fn3 a b c (Effect (Promise o)) -> a -> b -> c -> Aff o

runPromiseAffE4 :: forall a b c d o. Fn4 a b c d (Effect (Promise o)) -> a -> b -> c -> d -> Aff o

newtype KeyboardKey

See USKeyboardLayout for a list of all key names.

Constructors

• KeyboardKey String

keyboardDown :: forall options trash. Union options trash (text :: String) => KeyboardKey -> Record options -> Page -> Aff Unit

Dispatches a keydown event.

keyboardPress :: forall options trash. Union options trash (delay :: Int, text :: String) => KeyboardKey -> Record options -> Page -> Aff Unit

Trigger a single keypress. Shortcut for keyboard.down and keyboard.up.

keyboardSendCharacter :: String -> Page -> Aff Unit

Dispatches a keypress and input event. This does not send a keydown or keyup event.

keyboardType :: forall options trash. Union options trash (delay :: Number) => String -> Record options -> Page -> Aff Unit

Sends a keydown, keypress/input, and keyup event for each character in the text. To press a special key, like Control or ArrowDown, use keyboard.press.

keyboardUp :: forall options trash. Union options trash (text :: String) => KeyboardKey -> Record options -> Page -> Aff Unit

Dispatches a keyup event.

setViewport :: Record DefaultViewPort -> Page -> Aff Unit

set Viewport

setUserAgent :: String -> Page -> Aff Unit

Specific user agent to use in this page

bringToFront :: Page -> Aff Unit

Brings page to front (activates tab)

addScriptTag :: String -> Page -> Aff Unit

consoleMessageText :: ConsoleMessage -> Aff String

puppeteer :: Puppeteer

_puppeteer :: Puppeteer

_launch :: forall options. Fn1 options (Effect (Promise Browser))

_launchChromeAWS :: forall options. Fn2 ChromeAWS options (Effect (Promise Browser))

_newPage :: Fn1 Browser (Effect (Promise Page))

_pages :: Fn1 Browser (Effect (Promise (Array Page)))

_goto :: Fn2 URL Page (Effect (Promise Unit))

_close :: Fn1 Browser (Effect (Promise Unit))

_content :: Fn1 Page (Effect (Promise String))

_screenshot :: forall options. Fn2 options Page (Effect (Promise Buffer))

_pdf :: forall options. Fn2 options Page (Effect (Promise Buffer))

_on :: forall a. EffectFn3 String (EffectFn1 a Unit) Page Unit

_pageWaitForSelector :: forall options. Fn3 Selector options Page (Effect (Promise ElementHandle))

_select :: forall options. Fn3 Selector options Page (Effect (Promise Unit))

_focus :: Fn2 Selector Page (Effect (Promise Unit))

_setViewport :: Fn2 (Record DefaultViewPort) Page (Effect (Promise Unit))

_type :: forall options. Fn4 Selector String options Page (Effect (Promise Unit))

_click :: Fn2 Selector Page (Effect (Promise Unit))

_waitForNavigation :: forall options. Fn2 options Page (Effect (Promise Unit))

_getLocationHref :: Fn1 Page (Effect (Promise String))

_unsafeEvaluateOnNewDocument :: Fn2 String Page (Effect (Promise Foreign))

_unsafeEvaluateStringFunction :: Fn2 String Page (Effect (Promise Foreign))

_unsafePageEval :: Fn3 Selector String Page (Effect (Promise Foreign))

_unsafePageEvalAll :: Fn3 Selector String Page (Effect (Promise Foreign))

_keyboardDown :: forall options. Fn3 KeyboardKey options Page (Effect (Promise Unit))

_keyboardPress :: forall options. Fn3 KeyboardKey options Page (Effect (Promise Unit))

_keyboardSendCharacter :: Fn2 String Page (Effect (Promise Unit))

_keyboardType :: forall options. Fn3 String options Page (Effect (Promise Unit))

_keyboardUp :: forall options. Fn3 KeyboardKey options Page (Effect (Promise Unit))

_setUserAgent :: Fn2 String Page (Effect (Promise Unit))

_bringToFront :: Fn1 Page (Effect (Promise Unit))

_addScriptTag :: Fn2 String Page (Effect (Promise Unit))

_consoleMessageText :: Fn1 ConsoleMessage (Effect String)