webdriver-js-extender

  • Version 2.2.0
  • Published
  • 35 kB
  • 2 dependencies
  • MIT license

Install

npm i webdriver-js-extender
yarn add webdriver-js-extender
pnpm add webdriver-js-extender

Overview

A plugin which adds additional commands to selenium's javascript implementation of the webdriver client side API

Index

Functions

function extend

extend: (
baseDriver: WebDriver,
fallbackGracefully?: boolean
) => ExtendedWebDriver;

    Interfaces

    interface ExtendedWebDriver

    interface ExtendedWebDriver extends WebDriver {}

      property closeApp

      closeApp: () => wdpromise.Promise<void>;

        property fullscreen

        fullscreen: () => wdpromise.Promise<void>;

          property getAppiumSettings

          getAppiumSettings: () => wdpromise.Promise<{
          [name: string]: any;
          }>;

            property getAppStrings

            getAppStrings: (language?: string) => wdpromise.Promise<string[]>;

              property getCurrentContext

              getCurrentContext: () => wdpromise.Promise<string>;

                property getCurrentDeviceActivity

                getCurrentDeviceActivity: () => wdpromise.Promise<string>;

                  property getDeviceTime

                  getDeviceTime: () => wdpromise.Promise<string>;

                    property getGeolocation

                    getGeolocation: () => wdpromise.Promise<{
                    latitude: number;
                    longitude: number;
                    altitude: number;
                    }>;

                      property getNetworkConnection

                      getNetworkConnection: () => wdpromise.Promise<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7>;

                        property getScreenOrientation

                        getScreenOrientation: () => wdpromise.Promise<'LANDSCAPE' | 'PORTRAIT'>;

                          property hideSoftKeyboard

                          hideSoftKeyboard: (
                          strategy?:
                          | 'default'
                          | 'tapOutside'
                          | 'tapOut'
                          | 'swipeDown'
                          | 'pressKey'
                          | 'press',
                          key?: string
                          ) => wdpromise.Promise<void>;

                            property installApp

                            installApp: (appPath: string) => wdpromise.Promise<void>;

                              property isAppInstalled

                              isAppInstalled: (bundleId: string) => wdpromise.Promise<boolean>;

                                property isDeviceLocked

                                isDeviceLocked: () => wdpromise.Promise<boolean>;

                                  property launchSession

                                  launchSession: () => wdpromise.Promise<void>;

                                    property listContexts

                                    listContexts: () => wdpromise.Promise<string[]>;

                                      property lockDevice

                                      lockDevice: (delay?: number) => wdpromise.Promise<void>;

                                        property openDeviceNotifications

                                        openDeviceNotifications: () => wdpromise.Promise<void>;

                                          property pullFileFromDevice

                                          pullFileFromDevice: (path: string) => wdpromise.Promise<string>;

                                            property pullFolderFromDevice

                                            pullFolderFromDevice: (path: string) => wdpromise.Promise<any>;

                                              property pushFileToDevice

                                              pushFileToDevice: (path: string, base64Data: string) => wdpromise.Promise<void>;

                                                property removeApp

                                                removeApp: (appId: string) => wdpromise.Promise<void>;

                                                  property resetApp

                                                  resetApp: () => wdpromise.Promise<void>;

                                                    property rotationGesture

                                                    rotationGesture: (
                                                    x?: number,
                                                    y?: number,
                                                    duration?: number,
                                                    rotation?: number,
                                                    touchCount?: 1 | 2 | 3 | 4 | 5
                                                    ) => wdpromise.Promise<void>;

                                                      property selectContext

                                                      selectContext: (name: string) => wdpromise.Promise<void>;

                                                        property sendAppToBackground

                                                        sendAppToBackground: (delay?: number) => wdpromise.Promise<void>;

                                                          property sendChromiumCommand

                                                          sendChromiumCommand: (cmd: string, params: Object) => wdpromise.Promise<void>;

                                                            property sendChromiumCommandAndGetResult

                                                            sendChromiumCommandAndGetResult: (
                                                            cmd: string,
                                                            params: Object
                                                            ) => wdpromise.Promise<Object>;

                                                              property setAppiumSettings

                                                              setAppiumSettings: (settings: {
                                                              [name: string]: any;
                                                              }) => wdpromise.Promise<void>;

                                                                property setGeolocation

                                                                setGeolocation: (
                                                                latitude?: number,
                                                                longitude?: number,
                                                                altitude?: number
                                                                ) => wdpromise.Promise<void>;

                                                                  property setNetworkConnection

                                                                  setNetworkConnection: (
                                                                  typeOrAirplaneMode: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | boolean,
                                                                  wifi?: boolean,
                                                                  data?: boolean
                                                                  ) => wdpromise.Promise<void>;

                                                                    property setScreenOrientation

                                                                    setScreenOrientation: (orientation: string) => wdpromise.Promise<void>;

                                                                      property shakeDevice

                                                                      shakeDevice: () => wdpromise.Promise<void>;

                                                                        property startDeviceActivity

                                                                        startDeviceActivity: (
                                                                        appPackage: string,
                                                                        appActivity: string,
                                                                        appWaitPackage?: string,
                                                                        appWaitActivity?: string
                                                                        ) => wdpromise.Promise<void>;

                                                                          property switchToParentFrame

                                                                          switchToParentFrame: () => wdpromise.Promise<void>;

                                                                            property toggleAirplaneMode

                                                                            toggleAirplaneMode: () => wdpromise.Promise<void>;

                                                                              property toggleData

                                                                              toggleData: () => wdpromise.Promise<void>;

                                                                                property toggleLocationServices

                                                                                toggleLocationServices: () => wdpromise.Promise<void>;

                                                                                  property toggleWiFi

                                                                                  toggleWiFi: () => wdpromise.Promise<void>;

                                                                                    property unlockDevice

                                                                                    unlockDevice: () => wdpromise.Promise<void>;

                                                                                      property uploadFile

                                                                                      uploadFile: (base64Data: string) => wdpromise.Promise<void>;

                                                                                        Package Files (1)

                                                                                        Dependencies (2)

                                                                                        Dev Dependencies (8)

                                                                                        Peer Dependencies (0)

                                                                                        No peer dependencies.

                                                                                        Badge

                                                                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/webdriver-js-extender.

                                                                                        • Markdown
                                                                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/webdriver-js-extender)
                                                                                        • HTML
                                                                                          <a href="https://www.jsdocs.io/package/webdriver-js-extender"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>