1
0
mirror of https://github.com/MontFerret/ferret.git synced 2025-02-11 13:52:49 +02:00
ferret/pkg/stdlib/html/navigate_forward.go
Tim Voronov 24d8eedd4c
Feature/doc markup (#543)
* Added release notes

* #509 fixedOCOD typo

* Updated values

* Updated comments

* Changed stdlib docs format

* Changed format of array in docs

* Use 'any' instead of 'value' in docs

* New format for optional params

* Updated docs for testing package

* Added namespace information
2020-08-07 21:49:29 -04:00

60 lines
1.4 KiB
Go

package html
import (
"context"
"github.com/MontFerret/ferret/pkg/drivers"
"github.com/MontFerret/ferret/pkg/runtime/core"
"github.com/MontFerret/ferret/pkg/runtime/values"
"github.com/MontFerret/ferret/pkg/runtime/values/types"
)
// NAVIGATE_FORWARD navigates a given page forward within its navigation history.
// The operation blocks the execution until the page gets loaded.
// If the history is empty, the function returns FALSE.
// @param {HTMLPage} page - Target page.
// @param {Int} [entry=1] - An integer value indicating how many pages to skip.
// @param {Int} [timeout=5000] - Navigation timeout.
// @return {Boolean} - True if history exists and the operation succeeded, otherwise false.
func NavigateForward(ctx context.Context, args ...core.Value) (core.Value, error) {
err := core.ValidateArgs(args, 1, 3)
if err != nil {
return values.False, err
}
page, err := drivers.ToPage(args[0])
if err != nil {
return values.None, err
}
skip := values.NewInt(1)
timeout := values.NewInt(drivers.DefaultWaitTimeout)
if len(args) > 1 {
err = core.ValidateType(args[1], types.Int)
if err != nil {
return values.None, err
}
skip = args[1].(values.Int)
}
if len(args) > 2 {
err = core.ValidateType(args[2], types.Int)
if err != nil {
return values.None, err
}
timeout = args[2].(values.Int)
}
ctx, fn := waitTimeout(ctx, timeout)
defer fn()
return page.NavigateForward(ctx, skip)
}