Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "api/common-types"

Index

Type aliases

ElementIdForLog

ElementIdForLog: string

Alias which writes to log for the given element along with TEQ string.

TODO: Don't print TEQ to logs if idForLog is passed.

TODO: Add cmd line option '--force-print-teq', to print TEQ strings even if idForLogs are passed, just for debug.

EnableLog

EnableLog: boolean

Whether the action is to be written to log.

If true - the action is written.

If false - the action is not written.

Say, you create a high level function: 'login'. Say, your login consists of sendKeys to 'name', sendKeys to 'password', and press 'submit' button. You can use 'false' for these inner calls, and print some your string like 'login ... OK'. See also gT.e.q.wrap and gIn.wrap functions.

If this parameter is omitted - default 'enableLog' will be used. Note: Default enableLog is 'true' (gT.engineConsts.defLLLogAction).

Some API functions can use its own default enableLog, it this case such function description contains an explanation.

Note: the '--force-log-actions' cmd line option works as if all enableLog are true, so use it to debug your high level functions.

IdForLog

IdForLog: IdForLogObj | string

SeleniumKeys

SeleniumKeys: string | number | Array<string | number>