playwright-cucumber-ts-steps 0.1.7 → 1.0.1

package/lib/assertions/roleTestIdSteps.d.ts

@@ -1 +1,159 @@
-export {};
+import { CustomWorld } from "../helpers/world";
+/**
+ * Asserts that an element with the given ARIA role and exact accessible name is visible on the page.
+ *
+ * ```gherkin
+ * Then I see role {string} with name {string}
+ * ```
+ *
+ * @param role - The ARIA role of the element (e.g., "button", "heading", "textbox").
+ * @param name - The exact accessible name of the element (e.g., button text, label text).
+ *
+ * @example
+ * Then I see role "button" with name "Submit"
+ * Then I see role "heading" with name "Welcome"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByRole()` with `exact: true` for precise matching.
+ * It asserts that the matched element is visible in the viewport.
+ * @category Role-Based Assertion Steps
+ */
+export declare function Then_I_see_role_with_name(this: CustomWorld, role: string, name: string): Promise<void>;
+/**
+ * Asserts that an element with the given ARIA role and exact accessible name does NOT exist in the DOM.
+ *
+ * ```gherkin
+ * Then I do not see role {string} with name {string}
+ * ```
+ *
+ * @param role - The ARIA role of the element.
+ * @param name - The exact accessible name of the element.
+ *
+ * @example
+ * Then I do not see role "button" with name "Cancel"
+ * Then I do not see role "alert" with name "Error message"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByRole()` with `exact: true` and asserts that
+ * no such element exists in the DOM (i.e., its count is 0).
+ * @category Role-Based Assertion Steps
+ */
+export declare function Then_I_do_not_see_role_with_name(this: CustomWorld, role: string, name: string): Promise<void>;
+/**
+ * Asserts that an element with the given `data-testid` attribute (or configured test ID) is visible on the page.
+ *
+ * ```gherkin
+ * Then I see testid {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ *
+ * @example
+ * Then I see testid "main-content"
+ * Then I see testid "user-profile-section"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` and asserts that the matched element is visible.
+ * @category Test ID-Based Assertion Steps
+ */
+export declare function Then_I_see_testid(this: CustomWorld, testId: string): Promise<void>;
+/**
+ * Asserts that an element with the given `data-testid` attribute (or configured test ID) does NOT exist in the DOM.
+ *
+ * ```gherkin
+ * Then I do not see testid {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ *
+ * @example
+ * Then I do not see testid "sidebar"
+ * Then I do not see testid "legacy-component"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` and asserts that no such element exists (i.e., its count is 0).
+ * @category Test ID-Based Assertion Steps
+ */
+export declare function Then_I_do_not_see_testid(this: CustomWorld, testId: string): Promise<void>;
+/**
+ * Asserts that an element identified by its `data-testid` has a specific attribute with an exact expected value.
+ *
+ * ```gherkin
+ * Then I see testid {string} has attribute {string} with value {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ * @param attr - The name of the attribute (e.g., "data-state", "aria-expanded").
+ * @param value - The exact expected value of the attribute.
+ *
+ * @example
+ * Then I see testid "main-content" has attribute "data-state" with value "active"
+ * Then I see testid "toggle-button" has attribute "aria-pressed" with value "true"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` to find the element and then
+ * `expect(locator).toHaveAttribute()` for the assertion.
+ * @category Test ID-Based Attribute Assertion Steps
+ */
+export declare function Then_I_see_testid_has_attribute_with_value(this: CustomWorld, testId: string, attr: string, value: string): Promise<void>;
+/**
+ * Asserts that an element identified by its `data-testid` has a specific attribute, regardless of its value.
+ *
+ * ```gherkin
+ * Then I see testid {string} has attribute {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ * @param attr - The name of the attribute expected to exist (e.g., "data-custom-id", "disabled").
+ *
+ * @example
+ * Then I see testid "main-content" has attribute "data-state"
+ * Then I see testid "submit-button" has attribute "disabled"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` to find the element, then retrieves
+ * the attribute's value and asserts that it is not `null` (meaning the attribute is present).
+ * @category Test ID-Based Attribute Assertion Steps
+ */
+export declare function Then_I_see_testid_has_attribute(this: CustomWorld, testId: string, attr: string): Promise<void>;
+/**
+ * Asserts that an element identified by its `data-testid` does NOT have a specific attribute.
+ *
+ * ```gherkin
+ * Then I see testid {string} does not have attribute {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ * @param attr - The name of the attribute expected NOT to exist.
+ *
+ * @example
+ * Then I see testid "main-content" does not have attribute "data-state"
+ * Then I see testid "enabled-button" does not have attribute "disabled"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` to find the element, then retrieves
+ * the attribute's value and asserts that it is `null` (meaning the attribute is not present).
+ * @category Test ID-Based Attribute Assertion Steps
+ */
+export declare function Then_I_see_testid_does_not_have_attribute(this: CustomWorld, testId: string, attr: string): Promise<void>;
+/**
+ * Asserts that an element identified by its `data-testid` has a specific attribute whose value contains a given substring.
+ *
+ * ```gherkin
+ * Then I see testid {string} attribute {string} contains {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ * @param attr - The name of the attribute to check (e.g., "class", "aria-label").
+ * @param part - The substring expected to be contained within the attribute's value.
+ *
+ * @example
+ * Then I see testid "main-content" attribute "class" contains "active"
+ * Then I see testid "search-input" attribute "aria-label" contains "search product"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` to find the element and then
+ * `expect(locator).toHaveAttribute()` with a regular expression for the contains check.
+ * @category Test ID-Based Attribute Assertion Steps
+ */
+export declare function Then_I_see_testid_attribute_contains(this: CustomWorld, testId: string, attr: string, part: string): Promise<void>;

package/lib/assertions/roleTestIdSteps.js

@@ -1,26 +1,221 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Then_I_see_role_with_name = Then_I_see_role_with_name;
+exports.Then_I_do_not_see_role_with_name = Then_I_do_not_see_role_with_name;
+exports.Then_I_see_testid = Then_I_see_testid;
+exports.Then_I_do_not_see_testid = Then_I_do_not_see_testid;
+exports.Then_I_see_testid_has_attribute_with_value = Then_I_see_testid_has_attribute_with_value;
+exports.Then_I_see_testid_has_attribute = Then_I_see_testid_has_attribute;
+exports.Then_I_see_testid_does_not_have_attribute = Then_I_see_testid_does_not_have_attribute;
+exports.Then_I_see_testid_attribute_contains = Then_I_see_testid_attribute_contains;
 const cucumber_1 = require("@cucumber/cucumber");
 const test_1 = require("@playwright/test");
-//
-// 🧩 ROLE-BASED ELEMENTS
-//
-(0, cucumber_1.Then)(/^I see role "(.*)" with name "(.*)"$/, async function (role, name) {
-    const el = this.page.getByRole(role, { name, exact: true });
-    await (0, test_1.expect)(el).toBeVisible();
-});
-(0, cucumber_1.Then)(/^I do not see role "(.*)" with name "(.*)"$/, async function (role, name) {
-    const el = this.page.getByRole(role, { name, exact: true });
-    await (0, test_1.expect)(el).toHaveCount(0);
-});
-//
-// 🏷️ TEST ID-BASED ELEMENTS
-//
-(0, cucumber_1.Then)(/^I see testid "(.*)"$/, async function (testId) {
-    const el = this.page.getByTestId(testId);
-    await (0, test_1.expect)(el).toBeVisible();
-});
-(0, cucumber_1.Then)(/^I do not see testid "(.*)"$/, async function (testId) {
-    const el = this.page.getByTestId(testId);
-    await (0, test_1.expect)(el).toHaveCount(0);
-});
+// ===================================================================================
+// ASSERTIONS: ROLE-BASED ELEMENTS
+// ===================================================================================
+/**
+ * Asserts that an element with the given ARIA role and exact accessible name is visible on the page.
+ *
+ * ```gherkin
+ * Then I see role {string} with name {string}
+ * ```
+ *
+ * @param role - The ARIA role of the element (e.g., "button", "heading", "textbox").
+ * @param name - The exact accessible name of the element (e.g., button text, label text).
+ *
+ * @example
+ * Then I see role "button" with name "Submit"
+ * Then I see role "heading" with name "Welcome"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByRole()` with `exact: true` for precise matching.
+ * It asserts that the matched element is visible in the viewport.
+ * @category Role-Based Assertion Steps
+ */
+async function Then_I_see_role_with_name(role, name) {
+    const locator = this.page.getByRole(role, { name, exact: true });
+    await (0, test_1.expect)(locator).toBeVisible({ timeout: 5000 });
+    this.log?.(`✅ Verified role "${role}" with name "${name}" is visible.`);
+}
+(0, cucumber_1.Then)(/^I see role "(.*)" with name "(.*)"$/, Then_I_see_role_with_name);
+/**
+ * Asserts that an element with the given ARIA role and exact accessible name does NOT exist in the DOM.
+ *
+ * ```gherkin
+ * Then I do not see role {string} with name {string}
+ * ```
+ *
+ * @param role - The ARIA role of the element.
+ * @param name - The exact accessible name of the element.
+ *
+ * @example
+ * Then I do not see role "button" with name "Cancel"
+ * Then I do not see role "alert" with name "Error message"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByRole()` with `exact: true` and asserts that
+ * no such element exists in the DOM (i.e., its count is 0).
+ * @category Role-Based Assertion Steps
+ */
+async function Then_I_do_not_see_role_with_name(role, name) {
+    const locator = this.page.getByRole(role, { name, exact: true });
+    await (0, test_1.expect)(locator).toHaveCount(0, { timeout: 5000 });
+    this.log?.(`✅ Verified role "${role}" with name "${name}" does NOT exist.`);
+}
+(0, cucumber_1.Then)(/^I do not see role "(.*)" with name "(.*)"$/, Then_I_do_not_see_role_with_name);
+// ===================================================================================
+// ASSERTIONS: TEST ID-BASED ELEMENTS
+// ===================================================================================
+/**
+ * Asserts that an element with the given `data-testid` attribute (or configured test ID) is visible on the page.
+ *
+ * ```gherkin
+ * Then I see testid {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ *
+ * @example
+ * Then I see testid "main-content"
+ * Then I see testid "user-profile-section"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` and asserts that the matched element is visible.
+ * @category Test ID-Based Assertion Steps
+ */
+async function Then_I_see_testid(testId) {
+    const locator = this.page.getByTestId(testId);
+    await (0, test_1.expect)(locator).toBeVisible({ timeout: 5000 });
+    this.log?.(`✅ Verified test ID "${testId}" is visible.`);
+}
+(0, cucumber_1.Then)(/^I see testid "(.*)"$/, Then_I_see_testid);
+/**
+ * Asserts that an element with the given `data-testid` attribute (or configured test ID) does NOT exist in the DOM.
+ *
+ * ```gherkin
+ * Then I do not see testid {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ *
+ * @example
+ * Then I do not see testid "sidebar"
+ * Then I do not see testid "legacy-component"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` and asserts that no such element exists (i.e., its count is 0).
+ * @category Test ID-Based Assertion Steps
+ */
+async function Then_I_do_not_see_testid(testId) {
+    const locator = this.page.getByTestId(testId);
+    await (0, test_1.expect)(locator).toHaveCount(0, { timeout: 5000 });
+    this.log?.(`✅ Verified test ID "${testId}" does NOT exist.`);
+}
+(0, cucumber_1.Then)(/^I do not see testid "(.*)"$/, Then_I_do_not_see_testid);
+// ===================================================================================
+// ASSERTIONS: ATTRIBUTE-BASED ASSERTIONS (on Test ID elements)
+// ===================================================================================
+/**
+ * Asserts that an element identified by its `data-testid` has a specific attribute with an exact expected value.
+ *
+ * ```gherkin
+ * Then I see testid {string} has attribute {string} with value {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ * @param attr - The name of the attribute (e.g., "data-state", "aria-expanded").
+ * @param value - The exact expected value of the attribute.
+ *
+ * @example
+ * Then I see testid "main-content" has attribute "data-state" with value "active"
+ * Then I see testid "toggle-button" has attribute "aria-pressed" with value "true"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` to find the element and then
+ * `expect(locator).toHaveAttribute()` for the assertion.
+ * @category Test ID-Based Attribute Assertion Steps
+ */
+async function Then_I_see_testid_has_attribute_with_value(testId, attr, value) {
+    const locator = this.page.getByTestId(testId);
+    await (0, test_1.expect)(locator).toHaveAttribute(attr, value, { timeout: 5000 });
+    this.log?.(`✅ Verified test ID "${testId}" has attribute "${attr}" with value "${value}".`);
+}
+(0, cucumber_1.Then)(/^I see testid "(.*)" has attribute "(.*)" with value "(.*)"$/, Then_I_see_testid_has_attribute_with_value);
+/**
+ * Asserts that an element identified by its `data-testid` has a specific attribute, regardless of its value.
+ *
+ * ```gherkin
+ * Then I see testid {string} has attribute {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ * @param attr - The name of the attribute expected to exist (e.g., "data-custom-id", "disabled").
+ *
+ * @example
+ * Then I see testid "main-content" has attribute "data-state"
+ * Then I see testid "submit-button" has attribute "disabled"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` to find the element, then retrieves
+ * the attribute's value and asserts that it is not `null` (meaning the attribute is present).
+ * @category Test ID-Based Attribute Assertion Steps
+ */
+async function Then_I_see_testid_has_attribute(testId, attr) {
+    const locator = this.page.getByTestId(testId);
+    const attrValue = await locator.getAttribute(attr, { timeout: 5000 });
+    (0, test_1.expect)(attrValue).not.toBeNull();
+    this.log?.(`✅ Verified test ID "${testId}" has attribute "${attr}".`);
+}
+(0, cucumber_1.Then)(/^I see testid "(.*)" has attribute "(.*)"$/, Then_I_see_testid_has_attribute);
+/**
+ * Asserts that an element identified by its `data-testid` does NOT have a specific attribute.
+ *
+ * ```gherkin
+ * Then I see testid {string} does not have attribute {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ * @param attr - The name of the attribute expected NOT to exist.
+ *
+ * @example
+ * Then I see testid "main-content" does not have attribute "data-state"
+ * Then I see testid "enabled-button" does not have attribute "disabled"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` to find the element, then retrieves
+ * the attribute's value and asserts that it is `null` (meaning the attribute is not present).
+ * @category Test ID-Based Attribute Assertion Steps
+ */
+async function Then_I_see_testid_does_not_have_attribute(testId, attr) {
+    const locator = this.page.getByTestId(testId);
+    const attrValue = await locator.getAttribute(attr, { timeout: 5000 });
+    (0, test_1.expect)(attrValue).toBeNull();
+    this.log?.(`✅ Verified test ID "${testId}" does NOT have attribute "${attr}".`);
+}
+(0, cucumber_1.Then)(/^I see testid "(.*)" does not have attribute "(.*)"$/, Then_I_see_testid_does_not_have_attribute);
+/**
+ * Asserts that an element identified by its `data-testid` has a specific attribute whose value contains a given substring.
+ *
+ * ```gherkin
+ * Then I see testid {string} attribute {string} contains {string}
+ * ```
+ *
+ * @param testId - The value of the `data-testid` attribute.
+ * @param attr - The name of the attribute to check (e.g., "class", "aria-label").
+ * @param part - The substring expected to be contained within the attribute's value.
+ *
+ * @example
+ * Then I see testid "main-content" attribute "class" contains "active"
+ * Then I see testid "search-input" attribute "aria-label" contains "search product"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByTestId()` to find the element and then
+ * `expect(locator).toHaveAttribute()` with a regular expression for the contains check.
+ * @category Test ID-Based Attribute Assertion Steps
+ */
+async function Then_I_see_testid_attribute_contains(testId, attr, part) {
+    const locator = this.page.getByTestId(testId);
+    await (0, test_1.expect)(locator).toHaveAttribute(attr, new RegExp(part), { timeout: 5000 });
+    this.log?.(`✅ Verified test ID "${testId}" attribute "${attr}" contains "${part}".`);
+}
+(0, cucumber_1.Then)(/^I see testid "(.*)" attribute "(.*)" contains "(.*)"$/, Then_I_see_testid_attribute_contains);

package/lib/assertions/semanticSteps.d.ts

@@ -1 +1,176 @@
-export {};
+import { DataTable } from "@cucumber/cucumber";
+import type { CustomWorld } from "../helpers/world";
+/**
+ * Asserts that a heading element (h1-h6) containing the given text is visible on the page.
+ *
+ * ```gherkin
+ * Then I see heading {string}
+ * ```
+ *
+ * @param text - The text content expected within the heading.
+ *
+ * @example
+ * Then I see heading "Welcome to your account"
+ *
+ * @remarks
+ * This step searches for any HTML heading tag (`<h1>` through `<h6>`) that contains the specified text.
+ * It uses Playwright's `expect().toBeVisible()` to confirm both existence and visibility, which
+ * includes automatic waiting.
+ * @category Heading Assertion Steps
+ */
+export declare function Then_I_see_heading(this: CustomWorld, text: string): Promise<void>;
+/**
+ * Asserts that a heading element (h1-h6) containing the given text is NOT visible on the page.
+ *
+ * ```gherkin
+ * Then I do not see heading {string}
+ * ```
+ *
+ * @param text - The text content expected NOT to be visible within a heading.
+ *
+ * @example
+ * Then I do not see heading "Hidden Section"
+ *
+ * @remarks
+ * This step searches for any HTML heading tag (`<h1>` through `<h6>`) that contains the specified text.
+ * It uses Playwright's `expect().not.toBeVisible()` to confirm both absence and non-visibility,
+ * which includes automatic waiting.
+ * @category Heading Assertion Steps
+ */
+export declare function Then_I_do_not_see_heading(this: CustomWorld, text: string): Promise<void>;
+/**
+ * Asserts that a `<label>` element with the given text is visible on the page.
+ *
+ * ```gherkin
+ * Then I see label {string}
+ * ```
+ *
+ * @param text - The text content of the label expected to be visible.
+ *
+ * @example
+ * Then I see label "Username"
+ * Then I see label "I agree to the terms and conditions"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByLabel()` which is designed to find labels
+ * and implicitly connected form controls. It then uses `expect().toBeVisible()`
+ * to confirm visibility.
+ * @category Label Assertion Steps
+ */
+export declare function Then_I_see_label(this: CustomWorld, text: string): Promise<void>;
+/**
+ * Asserts that a `<label>` element with the given text is NOT visible on the page.
+ *
+ * ```gherkin
+ * Then I do not see label {string}
+ * ```
+ *
+ * @param text - The text content of the label expected NOT to be visible.
+ *
+ * @example
+ * Then I do not see label "Old Feature Toggle"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByLabel()` and then `expect().not.toBeVisible()`
+ * to confirm its non-visibility.
+ * @category Label Assertion Steps
+ */
+export declare function Then_I_do_not_see_label(this: CustomWorld, text: string): Promise<void>;
+/**
+ * Asserts that a link (`<a>` tag) with the given accessible name (text content) is visible on the page.
+ *
+ * ```gherkin
+ * Then I see link {string}
+ * ```
+ *
+ * @param text - The accessible name (text) of the link expected to be visible.
+ *
+ * @example
+ * Then I see link "Home"
+ * Then I see link "View Details"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByRole("link", { name: text })` for robust
+ * link finding based on accessible name, then `expect().toBeVisible()` for visibility.
+ * @category Link Assertion Steps
+ */
+export declare function Then_I_see_link(this: CustomWorld, text: string): Promise<void>;
+/**
+ * Asserts that a link (`<a>` tag) with the given accessible name (text content) is NOT visible on the page.
+ *
+ * ```gherkin
+ * Then I do not see link {string}
+ * ```
+ *
+ * @param text - The accessible name (text) of the link expected NOT to be visible.
+ *
+ * @example
+ * Then I do not see link "Admin Panel"
+ *
+ * @remarks
+ * This step uses Playwright's `page.getByRole("link", { name: text })` and then
+ * `expect().not.toBeVisible()` to confirm its non-visibility.
+ * @category Link Assertion Steps
+ */
+export declare function Then_I_do_not_see_link(this: CustomWorld, text: string): Promise<void>;
+/**
+ * Asserts that the number of elements found by the {@link CustomWorld.currentLocator | currentLocator}
+ * matches the expected count. If no `currentLocator` is set, it defaults to counting all elements (`*`).
+ *
+ * ```gherkin
+ * Then I count {int} element
+ * ```
+ *
+ * @param expectedCount - The expected number of elements.
+ *
+ * @example
+ * When I find elements by selector ".product-item"
+ * Then I count 10 element
+ *
+ * @remarks
+ * This step is designed to follow a "find elements" step that sets `this.currentLocator`
+ * or `this.elements` (if `this.elements` is the intended source, you might prefer a
+ * step like `Then I count {int} elements` which specifically targets `this.elements`).
+ * The current implementation uses `this.currentLocator` or defaults to `this.page.locator("*")`.
+ * @category Count Assertion Steps
+ */
+export declare function Then_I_count_current_locator_elements(this: CustomWorld, expectedCount: number): Promise<void>;
+/**
+ * Asserts that the current document title exactly matches the expected string.
+ *
+ * ```gherkin
+ * Then I see document title {string}
+ * ```
+ *
+ * @param expectedTitle - The exact title string expected for the document.
+ * @param table - (Optional) A Cucumber DataTable for Playwright `ExpectOptions` (e.g., `timeout`).
+ *
+ * @example
+ * Then I see document title "My Application Dashboard"
+ *
+ * @remarks
+ * This step uses Playwright's `expect(page).toHaveTitle()` for robust assertion,
+ * including automatic waiting for the title to become correct.
+ * @category Page State Assertion Steps
+ */
+export declare function Then_I_see_document_title(this: CustomWorld, expectedTitle: string, table?: DataTable): Promise<void>;
+/**
+ * Asserts that the current document title contains the expected substring (case-insensitive).
+ *
+ * ```gherkin
+ * Then I see document title contains {string}
+ * ```
+ *
+ * @param substring - The substring expected to be contained within the document title.
+ * @param table - (Optional) A Cucumber DataTable for Playwright `ExpectOptions`.
+ *
+ * @example
+ * Then I see document title contains "App Name"
+ * Then I see document title contains "Dashboard"
+ *
+ * @remarks
+ * This step uses Playwright's `expect(page).toHaveTitle()` with a case-insensitive regular
+ * expression for partial matching, ensuring automatic waiting.
+ * @category Page State Assertion Steps
+ */
+export declare function Then_I_see_document_title_contains(this: CustomWorld, substring: string, table?: DataTable): Promise<void>;