lib

func AttributeGet ¶

func AttributeGet(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

AttributeGet returns selected attributes from an HTML root.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param names {String...} Attribute names. @return {Object} Existing attribute values keyed by name.

func AttributeQuery ¶

func AttributeQuery(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

AttributeQuery returns selected attributes from the first matching element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param names {String...} Attribute names. @return {Object} Existing attribute values keyed by name.

func AttributeRemove ¶

func AttributeRemove(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

AttributeRemove removes attributes from an HTML root.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param names {String...} Attribute names to remove. @return {None} No value.

func AttributeSet ¶

func AttributeSet(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

AttributeSet sets one or more attributes on an HTML root.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param nameOrAttributes {String|Object} Attribute name or attribute map. @param value {String|Object?} Attribute value when a name is supplied. @return {None} No value.

func BaseURL ¶

func BaseURL(ctx context.Context, root runtime.Value) (runtime.Value, error)

BaseURL returns the effective base URL of a page or document.

@param root {HTMLPage|HTMLDocument} Page or document. @return {String} Effective document base URL.

func Blur ¶

func Blur(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Blur removes focus from an HTML root or selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String?} Element selector. @return {Boolean} Whether the target was blurred.

func Click ¶

func Click(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Click clicks an HTML root or selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selectorOrCount {String|Int?} Element selector or click count. @param count {Int?} Click count for a selected element. @return {Boolean} Whether the target was found and clicked.

func ClickAll ¶

func ClickAll(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

ClickAll clicks every element matching a selector.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param count {Int?} Clicks per element. @return {Boolean} Whether at least one element was found and clicked.

func CookieDel ¶

func CookieDel(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

CookieDel deletes cookies from a page.

@param page {HTMLPage} Target page. @param cookiesOrNames {Any...} Cookie values or cookie names to delete. @return {None} No value.

func CookieGet ¶

func CookieGet(ctx context.Context, root, nameValue runtime.Value) (runtime.Value, error)

CookieGet returns a named page cookie when present.

@param page {HTMLPage} Target page. @param name {String} Cookie name. @return {HTTPCookie|None} Cookie value or None.

func CookieSet ¶

func CookieSet(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

CookieSet sets cookies on a page.

@param page {HTMLPage} Target page. @param cookies {Any...} Cookie values to set. @return {None} No value.

func Download ¶

func Download(_ context.Context, url runtime.Value) (runtime.Value, error)

Download downloads a resource from a URL.

@param url {String} Resource URL. @return {Binary} Downloaded bytes.

func Element ¶

func Element(ctx context.Context, root, selectorValue runtime.Value) (runtime.Value, error)

Element returns the first element matching a selector.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @return {HTMLElement|None} Matching element or None.

func ElementExists ¶

func ElementExists(ctx context.Context, root, selectorValue runtime.Value) (runtime.Value, error)

ElementExists reports whether an element matches a selector.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @return {Boolean} Whether a matching element exists.

func Elements ¶

func Elements(ctx context.Context, root, selectorValue runtime.Value) (runtime.Value, error)

Elements returns all elements matching a selector.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @return {Array<HTMLElement>} Matching elements.

func ElementsCount ¶

func ElementsCount(ctx context.Context, root, selectorValue runtime.Value) (runtime.Value, error)

ElementsCount returns the number of elements matching a selector.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @return {Int} Number of matching elements.

func Focus ¶

func Focus(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Focus focuses an HTML root or selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String?} Element selector. @return {Boolean} Whether the target was focused.

func Frames ¶

func Frames(ctx context.Context, arg1, arg2, arg3 runtime.Value) (runtime.Value, error)

Frames returns page frames whose property matches a regular expression.

@param page {HTMLPage} Page whose frames to search. @param property {String} Frame property name. @param expression {String} Regular expression for the property value. @return {Array<HTMLDocument>} Matching frame documents.

func GetInnerHTML ¶

func GetInnerHTML(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

GetInnerHTML returns HTML from a root or selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String?} Element selector. @return {String} Inner HTML, or an empty string when no element matches.

func GetInnerHTMLAll ¶

func GetInnerHTMLAll(ctx context.Context, root, selectorValue runtime.Value) (runtime.Value, error)

GetInnerHTMLAll returns HTML from every matching element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @return {Array<String>} Inner HTML values in match order.

func GetInnerText ¶

func GetInnerText(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

GetInnerText returns text from a root or selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String?} Element selector. @return {String} Inner text, or an empty string when no element matches.

func GetInnerTextAll ¶

func GetInnerTextAll(ctx context.Context, root, selectorValue runtime.Value) (runtime.Value, error)

GetInnerTextAll returns text from every matching element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @return {Array<String>} Inner text values in match order.

func Hover ¶

func Hover(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Hover moves the mouse over an HTML root or selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String?} Element selector. @return {Boolean} Whether the target was hovered.

func Input ¶

func Input(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Input types a value into an HTML root or selected input element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param valueOrSelector {Any} Input value or element selector. @param valueOrDelay {Any?} Input value or keyboard delay. @param delay {Int?} Keyboard delay in milliseconds. @return {Boolean} Whether the target was found and received input.

func InputClear ¶

func InputClear(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

InputClear clears an HTML root or selected input element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String?} Element selector. @return {Boolean} Whether the target was found and cleared.

func IsHTMLDocument ¶

func IsHTMLDocument(_ context.Context, arg runtime.Value) (runtime.Value, error)

IsHTMLDocument reports whether a value is an HTML document.

@param value {Any} Value to inspect. @return {Boolean} Whether the value is an HTMLDocument.

func IsHTMLElement ¶

func IsHTMLElement(_ context.Context, arg runtime.Value) (runtime.Value, error)

IsHTMLElement reports whether a value is an HTML element.

@param value {Any} Value to inspect. @return {Boolean} Whether the value is an HTMLElement.

func MouseMoveXY ¶

func MouseMoveXY(ctx context.Context, root, xValue, yValue runtime.Value) (runtime.Value, error)

MouseMoveXY moves the mouse to absolute viewport coordinates.

@param root {HTMLPage|HTMLDocument} Page or document. @param x {Number} Horizontal coordinate. @param y {Number} Vertical coordinate. @return {Boolean} Whether the mouse position changed.

func Navigate ¶

func Navigate(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Navigate loads a URL in a page and waits for navigation to finish.

@param page {HTMLPage} Target page. @param url {String} Destination URL. @param timeout {Int?} Navigation timeout in milliseconds. @return {Boolean} True when navigation succeeds.

func NavigateBack ¶

func NavigateBack(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

NavigateBack moves backward through page history.

@param page {HTMLPage} Target page. @param skip {Int?} Number of history entries to skip. @param timeout {Int?} Navigation timeout in milliseconds. @return {Boolean} Whether history existed and navigation succeeded.

func NavigateForward ¶

func NavigateForward(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

NavigateForward moves forward through page history.

@param page {HTMLPage} Target page. @param skip {Int?} Number of history entries to skip. @param timeout {Int?} Navigation timeout in milliseconds. @return {Boolean} Whether history existed and navigation succeeded.

func Open ¶

func Open(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Open loads an HTML page from a URL.

Options may select a driver, timeout, user agent, cookie reuse, cookies, headers, ignored resources or status codes, viewport, source charset, and an initScript. For CDP, beforeDocument uses the browser's new-document mechanism; same-target frames inherit it subject to browser target limits. afterNavigation runs after Ferret's controlled navigation reaches main-frame readiness.

@param url {String} URL to load. @param params {Object?} Driver and page-loading options. @return {HTMLPage} Loaded page.

func OpenOrCastPage ¶

func OpenOrCastPage(ctx context.Context, value runtime.Value) (drivers.HTMLPage, bool, error)

func PDF ¶

func PDF(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

PDF renders a page or URL as a PDF document.

Options control orientation, headers and footers, background graphics, scale, paper size, margins, page ranges, templates, and CSS page-size preference.

@param target {HTMLPage|String} Page or URL to render. @param params {Object?} PDF layout and rendering options. @return {Binary} Rendered PDF bytes.

func PageExists ¶

func PageExists(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

PageExists reports whether a URL returns a successful HTTP response.

@param url {String} URL to check. @param options {Object?} Request options, including headers. @return {Boolean} Whether the URL returned a successful response.

func Pagination ¶

func Pagination(ctx context.Context, root, selectorValue runtime.Value) (runtime.Value, error)

Pagination returns an iterator that advances by clicking a selector.

The first iteration yields the current page without clicking.

@param page {HTMLPage} Page to paginate. @param selector {String} Next-page selector. @return {Iterator<Int>} Iterator over zero-based page positions.

func Parse ¶

func Parse(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Parse loads an HTML page from string or binary content.

Options may select a driver, cookie reuse, cookies, headers, and viewport.

@param html {String|Binary} HTML content. @param params {Object?} Driver and parsing options. @return {HTMLPage} Parsed page.

func Press ¶

func Press(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Press sends keyboard input to an HTML root.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param keys {String|Array<String>} Keyboard key or keys. @param count {Int?} Number of presses. @return {Boolean} True when the keys are sent.

func PressSelector ¶

func PressSelector(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

PressSelector sends keyboard input to a selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param keys {String|Array<String>} Keyboard key or keys. @param count {Int?} Number of presses. @return {Boolean} True when the keys are sent.

func RegisterLib ¶

func RegisterLib(ns runtime.Namespace) error

func RegisterLibLegacy ¶

func RegisterLibLegacy(ns runtime.Namespace) error

func ResolveURL ¶

func ResolveURL(ctx context.Context, root, url runtime.Value) (runtime.Value, error)

ResolveURL resolves a URL against a page or document's effective base URL.

@param root {HTMLPage|HTMLDocument} Page or document. @param url {String} URL to resolve. @return {String} Resolved URL.

func Screenshot ¶

func Screenshot(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Screenshot captures a screenshot of a page or URL.

The format is JPEG or PNG; quality applies only to JPEG.

@param target {HTMLPage|String} Page or URL to capture. @param params {Object?} Capture bounds, format, and quality options. @return {Binary} Screenshot bytes.

func ScrollBottom ¶

func ScrollBottom(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

ScrollBottom scrolls a page or document to the bottom.

@param root {HTMLPage|HTMLDocument} Page or document. @param options {Object?} Scroll behavior and alignment options. @return {Boolean} Whether scrolling was initiated.

func ScrollInto ¶

func ScrollInto(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

ScrollInto scrolls an HTML root or selected element into view.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selectorOrOptions {String|Object?} Element selector or scroll options. @param options {Object?} Scroll behavior and alignment options. @return {Boolean} Whether scrolling was initiated.

func ScrollTop ¶

func ScrollTop(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

ScrollTop scrolls a page or document to the top.

@param root {HTMLPage|HTMLDocument} Page or document. @param options {Object?} Scroll behavior and alignment options. @return {Boolean} Whether scrolling was initiated.

func ScrollXY ¶

func ScrollXY(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

ScrollXY scrolls a page or document to absolute coordinates.

@param root {HTMLPage|HTMLDocument} Page or document. @param x {Number} Horizontal coordinate. @param y {Number} Vertical coordinate. @param options {Object?} Scroll behavior and alignment options. @return {Boolean} Whether scrolling was initiated.

func Select ¶

func Select(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Select selects values in a select element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param valuesOrSelector {String|Array<String>} Values or element selector. @param values {String|Array<String>?} Values when a selector is supplied. @return {Array<String>} Selected values.

func SetInnerHTML ¶

func SetInnerHTML(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

SetInnerHTML sets HTML on a root or selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param htmlOrSelector {String} HTML content or element selector. @param html {String?} HTML content when a selector is supplied. @return {None} No value.

func SetInnerText ¶

func SetInnerText(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

SetInnerText sets text on a root or selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param textOrSelector {String} Text content or element selector. @param text {String?} Text content when a selector is supplied. @return {None} No value.

func StyleGet ¶

func StyleGet(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

StyleGet returns selected style values from an element.

@param element {HTMLElement} Target element. @param names {String...} Style names. @return {Object} Existing style values keyed by name.

func StyleRemove ¶

func StyleRemove(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

StyleRemove removes style values from an element.

@param element {HTMLElement} Target element. @param names {String...} Style names to remove. @return {None} No value.

func StyleSet ¶

func StyleSet(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

StyleSet sets one or more style values on an element.

@param element {HTMLElement} Target element. @param nameOrStyles {String|Object} Style name or style map. @param value {Any?} Style value when a name is supplied. @return {None} No value.

func URL ¶

func URL(ctx context.Context, root runtime.Value) (runtime.Value, error)

URL returns the current URL of a page or document.

@param root {HTMLPage|HTMLDocument} Page or document. @return {String} Current document URL.

func Unhover ¶

func Unhover(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

Unhover moves the mouse outside an HTML root or selected element.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String?} Element selector. @return {Boolean} Whether the mouse was moved away.

func ValidatePageRanges ¶

func ValidatePageRanges(pageRanges string) (bool, error)

func WaitAttribute ¶

func WaitAttribute(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitAttribute waits for an attribute value to appear.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selectorOrName {String} Element selector or attribute name. @param nameOrValue {Any} Attribute name or expected value. @param valueOrTimeout {Any?} Expected value or timeout. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the expected state is observed.

func WaitAttributeAll ¶

func WaitAttributeAll(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitAttributeAll waits for an attribute value on all matching elements.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param name {String} Attribute name. @param value {Any} Expected value. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the expected state is observed on every match.

func WaitClass ¶

func WaitClass(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitClass waits for a class to appear.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selectorOrClass {String} Element selector or class name. @param classOrTimeout {String|Int?} Class name or timeout. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the class appears.

func WaitClassAll ¶

func WaitClassAll(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitClassAll waits for a class on all matching elements.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param class {String} Class name. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the class appears on every match.

func WaitElement ¶

func WaitElement(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitElement waits for an element to appear.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the element appears.

func WaitNavigation ¶

func WaitNavigation(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitNavigation waits for page or frame navigation.

Navigation options may specify timeout, target URL, and frame.

@param page {HTMLPage} Target page. @param paramsOrTimeout {Int|Object?} Timeout or navigation options. @return {Boolean} True when navigation completes.

func WaitNoAttribute ¶

func WaitNoAttribute(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitNoAttribute waits for an attribute value to disappear.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selectorOrName {String} Element selector or attribute name. @param nameOrValue {Any} Attribute name or expected value. @param valueOrTimeout {Any?} Expected value or timeout. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the expected state is observed.

func WaitNoAttributeAll ¶

func WaitNoAttributeAll(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitNoAttributeAll waits for an attribute value to disappear from all matching elements.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param name {String} Attribute name. @param value {Any} Expected value. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the expected state is observed on every match.

func WaitNoClass ¶

func WaitNoClass(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitNoClass waits for a class to disappear.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selectorOrClass {String} Element selector or class name. @param classOrTimeout {String|Int?} Class name or timeout. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the class disappears.

func WaitNoClassAll ¶

func WaitNoClassAll(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitNoClassAll waits for a class to disappear from all matching elements.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param class {String} Class name. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the class disappears from every match.

func WaitNoElement ¶

func WaitNoElement(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitNoElement waits for an element to disappear.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the element disappears.

func WaitNoStyle ¶

func WaitNoStyle(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitNoStyle waits for a style value to disappear.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selectorOrName {String} Element selector or style name. @param nameOrValue {Any} Style name or expected value. @param valueOrTimeout {Any?} Expected value or timeout. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the expected state is observed.

func WaitNoStyleAll ¶

func WaitNoStyleAll(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitNoStyleAll waits for a style value to disappear from all matching elements.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param name {String} Style name. @param value {Any} Expected value. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the expected state is observed on every match.

func WaitStyle ¶

func WaitStyle(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitStyle waits for a style value to appear.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selectorOrName {String} Element selector or style name. @param nameOrValue {Any} Style name or expected value. @param valueOrTimeout {Any?} Expected value or timeout. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the expected state is observed.

func WaitStyleAll ¶

func WaitStyleAll(ctx context.Context, args ...runtime.Value) (runtime.Value, error)

WaitStyleAll waits for a style value on all matching elements.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param selector {String} Element selector. @param name {String} Style name. @param value {Any} Expected value. @param timeout {Int?} Wait timeout in milliseconds. @return {Boolean} True when the expected state is observed on every match.

func XPath ¶

func XPath(ctx context.Context, arg1, arg2 runtime.Value) (runtime.Value, error)

XPath evaluates an XPath expression against an HTML root.

@param root {HTMLPage|HTMLDocument|HTMLElement} HTML root. @param expression {String} XPath expression. @return {Any} XPath evaluation result.

func XPathSelector ¶

func XPathSelector(_ context.Context, expression runtime.Value) (runtime.Value, error)

XPathSelector creates a reusable XPath query selector.

@param expression {String} XPath expression. @return {QuerySelector} XPath query selector.