Class CustomSnippets

CustomSnippets are providing the possibility, to add custom code to your page-object, for matching elements.

export
class: CustomSnippets

Hierarchy

CustomSnippets

Index

Properties

Methods

Properties

Private clearFormCustomSnippet

clearFormCustomSnippet: ICustomSnippet[] = []

Private fillFormCustomSnippet

fillFormCustomSnippet: ICustomSnippet[] = []

Private getterFunctionCustomSnippet

getterFunctionCustomSnippet: ICustomSnippet[] = []

Methods

addForClearForm

addForClearForm(customSnippet: ICustomSnippet): void

- Defined in lib/code-generation/custom-snippet.ts:169
adds a new CustomSnippet to the list of CustomSnippets, which will be used.

memberof

CustomSnippets

Parameters
- customSnippet: ICustomSnippet
Returns void

addForFillForm

addForFillForm(customSnippet: Required<ICustomSnippet>): void

- Defined in lib/code-generation/custom-snippet.ts:160
adds a new CustomSnippet to the list of CustomSnippets, which will be used.

memberof

CustomSnippets

Parameters
- customSnippet: Required<ICustomSnippet>
Returns void

addForGetterFunctions

addForGetterFunctions(customSnippet: ICustomSnippet): void

- Defined in lib/code-generation/custom-snippet.ts:151
adds a new CustomSnippet to the list of CustomSnippets, which will be used.

memberof

CustomSnippets

Parameters
- customSnippet: ICustomSnippet
Returns void

Private execute

execute(element: E2eElement, codeBuilder: QueuedCodeBuilder, options: IPageObjectBuilderOptions, snippetsFor: "getterFunction" | "fillForm" | "clearForm"): void

- Defined in lib/code-generation/custom-snippet.ts:175
Parameters
- element: E2eElement
- codeBuilder: QueuedCodeBuilder
- options: IPageObjectBuilderOptions
- snippetsFor: "getterFunction" | "fillForm" | "clearForm"
Returns void

Private exists

exists(element: E2eElement, snippetsFor: "getterFunction" | "fillForm" | "clearForm"): boolean

- Defined in lib/code-generation/custom-snippet.ts:194
Parameters
- element: E2eElement
- snippetsFor: "getterFunction" | "fillForm" | "clearForm"
Returns boolean

Private types

types(element: E2eElement): string

- Defined in lib/code-generation/custom-snippet.ts:212
Parameters
- element: E2eElement
Returns string

Generated using TypeDoc