Module: @atomic-testing/core

Namespaces

• collectionUtil
• dateUtil
• domUtil
• escapeUtil
• listHelper
• locatorUtil
• timingUtil

Enumerations

• LocatorRelativePosition

Classes

• ComponentDriver
• ContainerDriver
• CssLocator
• ErrorBase
• LinkedCssLocator
• ListComponentDriver
• MissingPartError
• TestEngine
• TooManyMatchingElementError
• WaitForFailureError

Interfaces

• BlurOption
• ClickOption
• EnterTextOption
• FocusOption
• HoverOption
• IClickableDriver
• IComponentDriverOption
• IContainerDriverOption
• IExampleUnit
• IFormFieldDriver
• IInputDriver
• IMouseInteractableDriver
• IToggleDriver
• Interactor
• LinkedCssLocatorAttributeValueExtract
• LinkedCssLocatorInitializer
• ListComponentDriverOption
• ListComponentDriverSpecificOption
• MouseDownOption
• MouseEnterOption
• MouseLeaveOption
• MouseMoveOption
• MouseOption
• MouseOutOption
• MouseUpOption
• Point
• ScenePart
• WaitForOption

References

DateValidationFailureResult

Re-exports DateValidationFailureResult

---

DateValidationResult

Re-exports DateValidationResult

---

DateValidationSuccessResult

Re-exports DateValidationSuccessResult

---

HtmlInputDateType

Re-exports HtmlInputDateType

---

htmlInputDateTypes

Re-exports htmlInputDateTypes

Type Aliases

CssLocatorChain

Ƭ CssLocatorChain: CssLocator[]

Defined in

packages/core/src/locators/PartLocator.ts:3

---

CssProperty

Ƭ CssProperty: Exclude<keyof CSSStyleDeclaration, ["parentRule", "length", "getPropertyPriority", "getPropertyValue", "item", "removeProperty", "setProperty"]>

Supported CSS Properties

Defined in

packages/core/src/interactor/CssProperty.ts:4

---

LinkedCssLocatorSource

Ƭ LinkedCssLocatorSource: Object

Type declaration

Name	Type
_id	"byLinkedCssLocatorSource"
matchingTargetLocator	PartLocator
matchingTargetValueExtract	LinkedCssLocatorValueExtract
relative	LocatorRelativePosition
valueExtract	LinkedCssLocatorValueExtract

Defined in

packages/core/src/locators/LinkedCssLocator.ts:16

---

LinkedCssLocatorValueExtract

Ƭ LinkedCssLocatorValueExtract: LinkedCssLocatorAttributeValueExtract

Defined in

packages/core/src/locators/LinkedCssLocator.ts:14

---

LinkedCssLocatorValueExtractType

Ƭ LinkedCssLocatorValueExtractType: "text" | "attribute"

Defined in

packages/core/src/locators/LinkedCssLocator.ts:7

---

LocatorChain

Ƭ LocatorChain: PartLocator

Deprecated

LocatorChain is deprecated, please use PartLocator instead

Defined in

packages/core/src/locators/PartLocator.ts:9

---

LocatorType

Ƭ LocatorType: "css" | "xpath"

Defined in

packages/core/src/locators/LocatorType.ts:1

---

Nullable

Ƭ Nullable<T>: T | null

Type parameters

Name
T

Defined in

packages/core/src/dataTypes.ts:2

---

Optional

Ƭ Optional<T>: T | undefined

Type parameters

Name
T

Defined in

packages/core/src/dataTypes.ts:1

---

PartLocator

Ƭ PartLocator: CssLocator | CssLocatorChain

Defined in

packages/core/src/locators/PartLocator.ts:4

---

ScenePartDefinition

Ƭ ScenePartDefinition: ComponentPartDefinition<any> | ContainerPartDefinition<any, any> | ListComponentPartDefinition<any>

Defined in

packages/core/src/partTypes.ts:79

---

ScenePartDriver

Ƭ ScenePartDriver<T>: { [partName in keyof T]: InstanceType<T[partName]["driver"]> }

Type parameters

Name	Type
T	extends ScenePart

Defined in

packages/core/src/partTypes.ts:89

---

WaitForCondition

Ƭ WaitForCondition: "attached" | "visible" | "detached" | "hidden"

Defined in

packages/core/src/drivers/WaitForOption.ts:1

Variables

LocatorTypeLookup

• Const LocatorTypeLookup: Record<string, LocatorType>

Defined in

packages/core/src/locators/LocatorType.ts:3

---

MissingPartErrorId

• Const MissingPartErrorId: "MissingPartError"

Defined in

packages/core/src/errors/MissingPartError.ts:5

---

TooManyMatchingElementErrorId

• Const TooManyMatchingElementErrorId: "TooManyMatchingElementError"

Defined in

packages/core/src/errors/TooManyMatchingElementError.ts:5

---

WaitForFailureErrorId

• Const WaitForFailureErrorId: "WaitForFailureError"

Defined in

packages/core/src/errors/WaitForFailureError.ts:7

---

defaultWaitForOption

• Const defaultWaitForOption: Readonly<WaitForOption>

Defined in

packages/core/src/drivers/WaitForOption.ts:21

Functions

byAttribute

▸ byAttribute(name, value, relativeTo?): CssLocator

Parameters

Name	Type	Default value
name	string	undefined
value	string	undefined
relativeTo	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

CssLocator

Defined in

packages/core/src/locators/byAttribute.ts:12

---

byChecked

▸ byChecked(checked?, relative?): CssLocator

Parameters

Name	Type	Default value
checked	boolean	true
relative	LocatorRelativePosition	LocatorRelativePosition.Same

Returns

CssLocator

Defined in

packages/core/src/locators/byChecked.ts:10

---

byCssClass

▸ byCssClass(className, relativeTo?): CssLocator

Parameters

Name	Type	Default value
className	string | string[]	undefined
relativeTo	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

CssLocator

Defined in

packages/core/src/locators/byCssClass.ts:11

---

byCssSelector

▸ byCssSelector(selector, relativeTo?): CssLocator

Parameters

Name	Type	Default value
selector	string	undefined
relativeTo	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

CssLocator

Defined in

packages/core/src/locators/byCssSelector.ts:10

---

byDataTestId

▸ byDataTestId(id, relativeTo?): CssLocator

Parameters

Name	Type	Default value
id	string | string[]	undefined
relativeTo	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

CssLocator

Defined in

packages/core/src/locators/byDataTestId.ts:11

---

byInputType

▸ byInputType(type, relative?): CssLocator

Parameters

Name	Type	Default value
type	string	undefined
relative	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

CssLocator

Defined in

packages/core/src/locators/byInputType.ts:14

---

byLinkedElement

▸ byLinkedElement(relative?): Object

Parameters

Name	Type	Default value
relative	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

Object

Name	Type
onLinkedElement	(locator: PartLocator) => { extractAttribute: (attributeName: string) => { toMatchMyAttribute: (myAttributeName: string) => LinkedCssLocator } }

Defined in

packages/core/src/locators/byLinkedElement.ts:5

---

byName

▸ byName(value, relative?): CssLocator

Parameters

Name	Type	Default value
value	string	undefined
relative	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

CssLocator

Defined in

packages/core/src/locators/byName.ts:11

---

byRole

▸ byRole(value, relative?): CssLocator

Parameters

Name	Type	Default value
value	string	undefined
relative	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

CssLocator

Defined in

packages/core/src/locators/byRole.ts:11

---

byTagName

▸ byTagName(tagName, relative?): CssLocator

Parameters

Name	Type	Default value
tagName	string	undefined
relative	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

CssLocator

Defined in

packages/core/src/locators/byTagName.ts:10

---

byValue

▸ byValue(value, relative?): CssLocator

Parameters

Name	Type	Default value
value	string	undefined
relative	LocatorRelativePosition	LocatorRelativePosition.Descendent

Returns

CssLocator

Defined in

packages/core/src/locators/byValue.ts:11