drivers

Nov 22, 2021

Changes in this version

+ const NavigationEvent

+ const RequestEvent

+ const ResponseEvent

+ var HTTPRequestType = core.NewType("ferret.drivers.HTTPRequest")

+ var QuerySelectorType = core.NewType("ferret.drivers.QuerySelector")

type Container

+ func (c *Container) WithContext(ctx context.Context) context.Context

+ type DriverEntry struct

+ Driver Driver

+ Options []GlobalOption

type HTMLDocument

+ Scroll func(ctx context.Context, options ScrollOptions) error

type HTMLElement

+ WaitForAttributeBySelector func(ctx context.Context, selector QuerySelector, name values.String, ...) error

+ WaitForAttributeBySelectorAll func(ctx context.Context, selector QuerySelector, name values.String, ...) error

+ WaitForClassBySelector func(ctx context.Context, selector QuerySelector, class values.String, ...) error

+ WaitForClassBySelectorAll func(ctx context.Context, selector QuerySelector, class values.String, ...) error

+ WaitForElement func(ctx context.Context, selector QuerySelector, when WaitEvent) error

+ WaitForElementAll func(ctx context.Context, selector QuerySelector, when WaitEvent) error

+ WaitForStyleBySelector func(ctx context.Context, selector QuerySelector, name values.String, ...) error

+ WaitForStyleBySelectorAll func(ctx context.Context, selector QuerySelector, name values.String, ...) error

+ type HTTPRequest struct

+ Body []byte

+ Headers *HTTPHeaders

+ Method string

+ URL string

+ func (req *HTTPRequest) Compare(other core.Value) int64

+ func (req *HTTPRequest) Copy() core.Value

+ func (req *HTTPRequest) GetIn(ctx context.Context, path []core.Value) (core.Value, core.PathError)

+ func (req *HTTPRequest) Hash() uint64

+ func (req *HTTPRequest) MarshalJSON() ([]byte, error)

+ func (req *HTTPRequest) String() string

+ func (req *HTTPRequest) Type() core.Type

+ func (req *HTTPRequest) Unwrap() interface{}

type HTTPResponse

+ Body []byte

+ ResponseTime float64

+ URL string

+ type QuerySelector struct

+ func NewCSSSelector(value values.String) QuerySelector

+ func NewXPathSelector(value values.String) QuerySelector

+ func ToQuerySelector(value core.Value) (QuerySelector, error)

+ func (q QuerySelector) Compare(other core.Value) int64

+ func (q QuerySelector) Copy() core.Value

+ func (q QuerySelector) Hash() uint64

+ func (q QuerySelector) Kind() QuerySelectorKind

+ func (q QuerySelector) MarshalJSON() ([]byte, error)

+ func (q QuerySelector) String() string

+ func (q QuerySelector) Type() core.Type

+ func (q QuerySelector) Unwrap() interface{}

+ type QuerySelectorKind int

+ const CSSSelector

+ const UnknownSelector

+ const XPathSelector

+ func (v QuerySelectorKind) String() string

type ScrollBehavior

+ func (b ScrollBehavior) MarshalJSON() ([]byte, error)

type ScrollHorizontalAlignment

+ func (a ScrollHorizontalAlignment) MarshalJSON() ([]byte, error)

type ScrollOptions

+ Left values.Float

+ Top values.Float

type ScrollVerticalAlignment

+ func (a ScrollVerticalAlignment) MarshalJSON() ([]byte, error)

Apr 23, 2021

Changes in this version

+ type Container struct

+ func NewContainer() *Container

+ func (c *Container) Get(name string) (Driver, bool)

+ func (c *Container) GetAll() []Driver

+ func (c *Container) Has(name string) bool

+ func (c *Container) Register(drv Driver) error

+ func (c *Container) Remove(name string)

type HTMLElement

+ Press func(ctx context.Context, keys []values.String, count values.Int) error

+ PressBySelector func(ctx context.Context, selector values.String, keys []values.String, ...) error

type Params

+ Charset string

Mar 27, 2021

Changes in this version

+ type GlobalOption func(drv Driver, opts *globalOptions)

type HTTPCookies

+ func NewHTTPCookiesWith(values map[string]HTTPCookie) *HTTPCookies

+ func (c *HTTPCookies) Clone() core.Cloneable

+ func (c *HTTPCookies) ForEach(predicate func(value HTTPCookie, key values.String) bool)

+ func (c *HTTPCookies) Values() []HTTPCookie

type HTTPHeaders

+ func NewHTTPHeadersWith(values map[string][]string) *HTTPHeaders

+ func (h *HTTPHeaders) Clone() core.Cloneable

+ func (h *HTTPHeaders) ForEach(predicate func(value []string, key string) bool)

+ func (h *HTTPHeaders) Length() values.Int

+ func (h *HTTPHeaders) SetArr(key string, value []string)

type Option

+ func WithCookie(cookie HTTPCookie) Option

+ func WithCookies(cookies []HTTPCookie) Option

+ func WithCustomName(name string) Option

+ func WithHeader(name string, value []string) Option

+ func WithHeaders(headers *HTTPHeaders) Option

+ func WithProxy(address string) Option

+ func WithUserAgent(value string) Option

+ type Options struct

+ Cookies *HTTPCookies

+ Headers *HTTPHeaders

+ Name string

+ Proxy string

+ UserAgent string

type Params

+ func SetDefaultParams(opts *Options, params Params) Params

Mar 5, 2021

Changes in this version

+ type Ignore struct

+ Resources []ResourceFilter

+ StatusCodes []StatusCodeFilter

type Params

+ Ignore *Ignore

+ type ResourceFilter struct

+ Type string

+ URL string

+ type StatusCodeFilter struct

+ Code int

+ URL string

Nov 24, 2020

Changes in this version

type HTMLElement

+ GetNextElementSibling func(ctx context.Context) (core.Value, error)

+ GetParentElement func(ctx context.Context) (core.Value, error)

+ GetPreviousElementSibling func(ctx context.Context) (core.Value, error)

Sep 15, 2020

Changes in this version

type HTMLPage

+ WaitForFrameNavigation func(ctx context.Context, frame HTMLDocument, targetURL values.String) error

May 21, 2020

Changes in this version

+ type ScrollBehavior int

+ const ScrollBehaviorAuto

+ const ScrollBehaviorInstant

+ const ScrollBehaviorSmooth

+ func NewScrollBehavior(value string) ScrollBehavior

+ func (b ScrollBehavior) String() string

+ type ScrollHorizontalAlignment int

+ const ScrollHorizontalAlignmentCenter

+ const ScrollHorizontalAlignmentEnd

+ const ScrollHorizontalAlignmentNearest

+ const ScrollHorizontalAlignmentStart

+ func NewScrollHorizontalAlignment(value string) ScrollHorizontalAlignment

+ func (a ScrollHorizontalAlignment) String() string

+ type ScrollOptions struct

+ Behavior ScrollBehavior

+ Block ScrollVerticalAlignment

+ Inline ScrollHorizontalAlignment

+ type ScrollVerticalAlignment int

+ const ScrollVerticalAlignmentCenter

+ const ScrollVerticalAlignmentEnd

+ const ScrollVerticalAlignmentNearest

+ const ScrollVerticalAlignmentStart

+ func NewScrollVerticalAlignment(value string) ScrollVerticalAlignment

+ func (a ScrollVerticalAlignment) String() string

Feb 21, 2020

Changes in this version

+ var HTTPCookiesType = core.NewType("HTTPCookies")

+ var HTTPResponseType = core.NewType("HTTPResponse")

type Driver

+ Parse func(ctx context.Context, params ParseParams) (HTMLPage, error)

type HTMLPage

+ GetResponse func(ctx context.Context) (HTTPResponse, error)

type HTTPCookies

+ func NewHTTPCookies() HTTPCookies

+ func (c HTTPCookies) Compare(other core.Value) int64

+ func (c HTTPCookies) Copy() core.Value

+ func (c HTTPCookies) Get(key values.String) (core.Value, values.Boolean)

+ func (c HTTPCookies) GetIn(ctx context.Context, path []core.Value) (core.Value, error)

+ func (c HTTPCookies) Hash() uint64

+ func (c HTTPCookies) Keys() []values.String

+ func (c HTTPCookies) Length() values.Int

+ func (c HTTPCookies) MarshalJSON() ([]byte, error)

+ func (c HTTPCookies) Set(key values.String, value core.Value)

+ func (c HTTPCookies) String() string

+ func (c HTTPCookies) Type() core.Type

+ func (c HTTPCookies) Unwrap() interface{}

+ type HTTPResponse struct

+ Headers HTTPHeaders

+ Status string

+ StatusCode int

+ func (resp *HTTPResponse) Compare(other core.Value) int64

+ func (resp *HTTPResponse) Copy() core.Value

+ func (resp *HTTPResponse) GetIn(ctx context.Context, path []core.Value) (core.Value, error)

+ func (resp *HTTPResponse) Hash() uint64

+ func (resp *HTTPResponse) MarshalJSON() ([]byte, error)

+ func (resp *HTTPResponse) String() string

+ func (resp *HTTPResponse) Type() core.Type

+ func (resp *HTTPResponse) Unwrap() interface{}

+ type ParseParams struct

+ Content []byte

+ Cookies HTTPCookies

+ Headers HTTPHeaders

+ KeepCookies bool

+ Viewport *Viewport

Sep 10, 2019

Changes in this version

+ const DefaultKeyboardDelay

+ const DefaultMouseDelay

+ const DefaultPageLoadTimeout

+ const DefaultWaitTimeout

type HTMLElement

+ Blur func(ctx context.Context) error

+ BlurBySelector func(ctx context.Context, selector values.String) error

+ Clear func(ctx context.Context) error

+ ClearBySelector func(ctx context.Context, selector values.String) error

+ ClickBySelector func(ctx context.Context, selector values.String, count values.Int) error

+ ClickBySelectorAll func(ctx context.Context, selector values.String, count values.Int) error

+ FocusBySelector func(ctx context.Context, selector values.String) error

+ HoverBySelector func(ctx context.Context, selector values.String) error

+ InputBySelector func(ctx context.Context, selector values.String, value core.Value, ...) error

+ SelectBySelector func(ctx context.Context, selector values.String, value *values.Array) (*values.Array, error)

+ type HTTPCookies map[string]HTTPCookie

Aug 5, 2019

Changes in this version

+ type HTTPHeaders map[string][]string

+ func NewHTTPHeaders(values map[string][]string) HTTPHeaders

+ func (h HTTPHeaders) Compare(other core.Value) int64

+ func (h HTTPHeaders) Copy() core.Value

+ func (h HTTPHeaders) Get(key string) string

+ func (h HTTPHeaders) GetIn(_ context.Context, path []core.Value) (core.Value, error)

+ func (h HTTPHeaders) Hash() uint64

+ func (h HTTPHeaders) MarshalJSON() ([]byte, error)

+ func (h HTTPHeaders) Set(key, value string)

+ func (h HTTPHeaders) String() string

+ func (h HTTPHeaders) Type() core.Type

+ func (h HTTPHeaders) Unwrap() interface{}

type Params

+ Headers HTTPHeaders

Jul 23, 2019

Changes in this version

+ var ErrDetached = errors.New("element detached")

+ var ErrNotFound = errors.New("element(s) not found")

+ var HTMLPageType = core.NewType("HTMLPageType")

type Driver

+ Open func(ctx context.Context, params Params) (HTMLPage, error)

type HTMLDocument

+ func ToDocument(value core.Value) (HTMLDocument, error)

+ FocusBySelector func(ctx context.Context, selector values.String) error

+ GetChildDocuments func(ctx context.Context) (*values.Array, error)

+ GetElement func() HTMLElement

+ GetName func() values.String

+ GetParentDocument func() HTMLDocument

+ GetTitle func() values.String

type HTMLElement

+ func ToElement(value core.Value) (HTMLElement, error)

+ Focus func(ctx context.Context) error

+ GetInnerHTML func(ctx context.Context) (values.String, error)

+ GetInnerHTMLBySelector func(ctx context.Context, selector values.String) (values.String, error)

+ GetInnerHTMLBySelectorAll func(ctx context.Context, selector values.String) (*values.Array, error)

+ GetInnerText func(ctx context.Context) (values.String, error)

+ GetInnerTextBySelector func(ctx context.Context, selector values.String) (values.String, error)

+ GetInnerTextBySelectorAll func(ctx context.Context, selector values.String) (*values.Array, error)

+ SetInnerHTML func(ctx context.Context, innerHTML values.String) error

+ SetInnerHTMLBySelector func(ctx context.Context, selector, innerHTML values.String) error

+ SetInnerText func(ctx context.Context, innerText values.String) error

+ SetInnerTextBySelector func(ctx context.Context, selector, innerText values.String) error

type HTMLNode

+ GetNodeName func() values.String

+ GetNodeType func() values.Int

+ IsDetached func() values.Boolean

+ XPath func(ctx context.Context, expression values.String) (core.Value, error)

+ type HTMLPage interface

+ CaptureScreenshot func(ctx context.Context, params ScreenshotParams) (values.Binary, error)

+ DeleteCookies func(ctx context.Context, cookies ...HTTPCookie) error

+ GetCookies func(ctx context.Context) (*values.Array, error)

+ GetFrame func(ctx context.Context, idx values.Int) (core.Value, error)

+ GetFrames func(ctx context.Context) (*values.Array, error)

+ GetMainFrame func() HTMLDocument

+ GetURL func() values.String

+ IsClosed func() values.Boolean

+ Navigate func(ctx context.Context, url values.String) error

+ NavigateBack func(ctx context.Context, skip values.Int) (values.Boolean, error)

+ NavigateForward func(ctx context.Context, skip values.Int) (values.Boolean, error)

+ PrintToPDF func(ctx context.Context, params PDFParams) (values.Binary, error)

+ SetCookies func(ctx context.Context, cookies ...HTTPCookie) error

+ WaitForNavigation func(ctx context.Context) error

+ func ToPage(value core.Value) (HTMLPage, error)

+ type Params struct

+ Cookies []HTTPCookie

+ Header HTTPHeader

+ KeepCookies bool

+ URL string

+ UserAgent string

+ Viewport *Viewport

type SameSite

+ func (s SameSite) String() string

+ type Viewport struct

+ Height int

+ Landscape bool

+ Mobile bool

+ ScaleFactor float64

+ Width int

Mar 19, 2019

Changes in this version

+ const DefaultTimeout

+ const WaitEventAbsence

+ const WaitEventPresence

+ var HTMLDocumentType = core.NewType("HTMLDocument")

+ var HTMLElementType = core.NewType("HTMLElement")

+ var HTTPCookieType = core.NewType("HTTPCookie")

+ var HTTPHeaderType = core.NewType("HTTPHeader")

+ func Compare(first, second core.Type) int64

+ func IsScreenshotFormatValid(format string) bool

+ func WithContext(ctx context.Context, drv Driver, opts ...Option) context.Context

+ func WithDefaultTimeout(ctx context.Context) (context.Context, context.CancelFunc)

+ type Driver interface

+ LoadDocument func(ctx context.Context, params LoadDocumentParams) (HTMLDocument, error)

+ Name func() string

+ func FromContext(ctx context.Context, name string) (Driver, error)

+ type HTMLDocument interface

+ CaptureScreenshot func(ctx context.Context, params ScreenshotParams) (values.Binary, error)

+ ClickBySelector func(ctx context.Context, selector values.String) (values.Boolean, error)

+ ClickBySelectorAll func(ctx context.Context, selector values.String) (values.Boolean, error)

+ DeleteCookies func(ctx context.Context, cookies ...HTTPCookie) error

+ DocumentElement func() HTMLElement

+ GetCookies func(ctx context.Context) (*values.Array, error)

+ GetURL func() core.Value

+ InputBySelector func(ctx context.Context, selector values.String, value core.Value, ...) (values.Boolean, error)

+ MoveMouseBySelector func(ctx context.Context, selector values.String) error

+ MoveMouseByXY func(ctx context.Context, x, y values.Float) error

+ Navigate func(ctx context.Context, url values.String) error

+ NavigateBack func(ctx context.Context, skip values.Int) (values.Boolean, error)

+ NavigateForward func(ctx context.Context, skip values.Int) (values.Boolean, error)

+ PrintToPDF func(ctx context.Context, params PDFParams) (values.Binary, error)

+ ScrollBottom func(ctx context.Context) error

+ ScrollBySelector func(ctx context.Context, selector values.String) error

+ ScrollByXY func(ctx context.Context, x, y values.Float) error

+ ScrollTop func(ctx context.Context) error

+ SelectBySelector func(ctx context.Context, selector values.String, value *values.Array) (*values.Array, error)

+ SetCookies func(ctx context.Context, cookies ...HTTPCookie) error

+ SetURL func(ctx context.Context, url values.String) error

+ WaitForAttributeBySelector func(ctx context.Context, selector, name values.String, value core.Value, ...) error

+ WaitForAttributeBySelectorAll func(ctx context.Context, selector, name values.String, value core.Value, ...) error

+ WaitForClassBySelector func(ctx context.Context, selector, class values.String, when WaitEvent) error

+ WaitForClassBySelectorAll func(ctx context.Context, selector, class values.String, when WaitEvent) error

+ WaitForElement func(ctx context.Context, selector values.String, when WaitEvent) error

+ WaitForNavigation func(ctx context.Context) error

+ WaitForStyleBySelector func(ctx context.Context, selector, name values.String, value core.Value, ...) error

+ WaitForStyleBySelectorAll func(ctx context.Context, selector, name values.String, value core.Value, ...) error

+ type HTMLElement interface

+ Click func(ctx context.Context) (values.Boolean, error)

+ GetAttribute func(ctx context.Context, name values.String) core.Value

+ GetAttributes func(ctx context.Context) *values.Object

+ GetStyle func(ctx context.Context, name values.String) (core.Value, error)

+ GetStyles func(ctx context.Context) (*values.Object, error)

+ GetValue func(ctx context.Context) core.Value

+ Hover func(ctx context.Context) error

+ InnerHTML func(ctx context.Context) values.String

+ InnerHTMLBySelector func(ctx context.Context, selector values.String) values.String

+ InnerHTMLBySelectorAll func(ctx context.Context, selector values.String) *values.Array

+ InnerText func(ctx context.Context) values.String

+ InnerTextBySelector func(ctx context.Context, selector values.String) values.String

+ InnerTextBySelectorAll func(ctx context.Context, selector values.String) *values.Array

+ Input func(ctx context.Context, value core.Value, delay values.Int) error

+ RemoveAttribute func(ctx context.Context, name ...values.String) error

+ RemoveStyle func(ctx context.Context, name ...values.String) error

+ ScrollIntoView func(ctx context.Context) error

+ Select func(ctx context.Context, value *values.Array) (*values.Array, error)

+ SetAttribute func(ctx context.Context, name, value values.String) error

+ SetAttributes func(ctx context.Context, values *values.Object) error

+ SetStyle func(ctx context.Context, name values.String, value core.Value) error

+ SetStyles func(ctx context.Context, values *values.Object) error

+ SetValue func(ctx context.Context, value core.Value) error

+ WaitForAttribute func(ctx context.Context, name values.String, value core.Value, when WaitEvent) error

+ WaitForClass func(ctx context.Context, class values.String, when WaitEvent) error

+ WaitForStyle func(ctx context.Context, name values.String, value core.Value, when WaitEvent) error

+ type HTMLNode interface

+ CountBySelector func(ctx context.Context, selector values.String) values.Int

+ ExistsBySelector func(ctx context.Context, selector values.String) values.Boolean

+ GetChildNode func(ctx context.Context, idx values.Int) core.Value

+ GetChildNodes func(ctx context.Context) core.Value

+ NodeName func() values.String

+ NodeType func() values.Int

+ QuerySelector func(ctx context.Context, selector values.String) core.Value

+ QuerySelectorAll func(ctx context.Context, selector values.String) core.Value

+ type HTTPCookie struct

+ Domain string

+ Expires time.Time

+ HTTPOnly bool

+ MaxAge int

+ Name string

+ Path string

+ SameSite SameSite

+ Secure bool

+ Value string

+ func (c HTTPCookie) Compare(other core.Value) int64

+ func (c HTTPCookie) Copy() core.Value

+ func (c HTTPCookie) GetIn(_ context.Context, path []core.Value) (core.Value, error)

+ func (c HTTPCookie) Hash() uint64

+ func (c HTTPCookie) MarshalJSON() ([]byte, error)

+ func (c HTTPCookie) String() string

+ func (c HTTPCookie) Type() core.Type

+ func (c HTTPCookie) Unwrap() interface{}

+ type HTTPHeader map[string][]string

+ func (h HTTPHeader) Compare(other core.Value) int64

+ func (h HTTPHeader) Copy() core.Value

+ func (h HTTPHeader) Get(key string) string

+ func (h HTTPHeader) GetIn(_ context.Context, path []core.Value) (core.Value, error)

+ func (h HTTPHeader) Hash() uint64

+ func (h HTTPHeader) MarshalJSON() ([]byte, error)

+ func (h HTTPHeader) Set(key, value string)

+ func (h HTTPHeader) String() string

+ func (h HTTPHeader) Type() core.Type

+ func (h HTTPHeader) Unwrap() interface{}

+ type LoadDocumentParams struct

+ Cookies []HTTPCookie

+ Header HTTPHeader

+ KeepCookies bool

+ URL string

+ UserAgent string

+ type Option func(drv Driver, opts *options)

+ func AsDefault() Option

+ type PDFParams struct

+ DisplayHeaderFooter values.Boolean

+ FooterTemplate values.String

+ HeaderTemplate values.String

+ IgnoreInvalidPageRanges values.Boolean

+ Landscape values.Boolean

+ MarginBottom values.Float

+ MarginLeft values.Float

+ MarginRight values.Float

+ MarginTop values.Float

+ PageRanges values.String

+ PaperHeight values.Float

+ PaperWidth values.Float

+ PreferCSSPageSize values.Boolean

+ PrintBackground values.Boolean

+ Scale values.Float

+ func NewDefaultHTMLPDFParams() PDFParams

+ type SameSite int

+ const SameSiteDefaultMode

+ const SameSiteLaxMode

+ const SameSiteStrictMode

+ type ScreenshotFormat string

+ const ScreenshotFormatJPEG

+ const ScreenshotFormatPNG

+ type ScreenshotParams struct

+ Format ScreenshotFormat

+ Height values.Float

+ Quality values.Int

+ Width values.Float

+ X values.Float

+ Y values.Float

+ type WaitEvent int

Dec 25, 2018

Changes in this version

+ func WithDynamic(ctx context.Context, drv Dynamic) context.Context

+ func WithStatic(ctx context.Context, drv Static) context.Context

+ type Dynamic interface

+ GetDocument func(ctx context.Context, url values.String) (values.DHTMLDocument, error)

+ func DynamicFrom(ctx context.Context) (Dynamic, error)

+ type Static interface

+ GetDocument func(ctx context.Context, url values.String) (values.HTMLDocument, error)

+ ParseDocument func(ctx context.Context, str values.String) (values.HTMLDocument, error)

+ func StaticFrom(ctx context.Context) (Static, error)