Skip to content

fixed: TS typings for Codecept and MainConfig #5216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 29, 2025
Merged

fixed: TS typings for Codecept and MainConfig #5216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion lib/codecept.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,14 +122,16 @@ class Codecept {
/**
* Executes bootstrap.
*
* @returns {Promise<void>}
*/
async bootstrap() {
return runHook(this.config.bootstrap, 'bootstrap')
}

/**
* Executes teardown.

*
* @returns {Promise<void>}
*/
async teardown() {
return runHook(this.config.teardown, 'teardown')
Expand Down Expand Up @@ -262,6 +264,11 @@ class Codecept {
})
}

/**
* Returns the version string of CodeceptJS.
*
* @returns {string} The version string.
*/
static version() {
return JSON.parse(readFileSync(`${__dirname}/../package.json`, 'utf8')).version
}
Expand Down
21 changes: 10 additions & 11 deletions typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ declare namespace CodeceptJS {
* tests: 'tests/**.test.ts'
* ```
*/
tests: string
tests: string | string[]
/**
* Where to store failure screenshots, artifacts, etc
*
Expand Down Expand Up @@ -520,17 +520,16 @@ declare namespace CodeceptJS {
}
}

type TryTo = <T>(fn: () => Promise<T> | T) => Promise<T | false>;
type HopeThat = <T>(fn: () => Promise<T> | T) => Promise<T | false>;
type RetryTo = <T>(fn: () => Promise<T> | T, retries?: number) => Promise<T>;

type TryTo = <T>(fn: () => Promise<T> | T) => Promise<T | false>
type HopeThat = <T>(fn: () => Promise<T> | T) => Promise<T | false>
type RetryTo = <T>(fn: () => Promise<T> | T, retries?: number) => Promise<T>

// Globals
declare const codecept_dir: string
declare const output_dir: string
declare const tryTo: TryTo;
declare const retryTo: RetryTo;
declare const hopeThat: HopeThat;
declare const tryTo: TryTo
declare const retryTo: RetryTo
declare const hopeThat: HopeThat

declare const actor: CodeceptJS.actor
declare const codecept_actor: CodeceptJS.actor
Expand Down Expand Up @@ -643,7 +642,7 @@ declare module '@codeceptjs/helper' {
}

declare module 'codeceptjs/effects' {
export const tryTo: TryTo;
export const retryTo: RetryTo;
export const hopeThat: HopeThat;
export const tryTo: TryTo
export const retryTo: RetryTo
export const hopeThat: HopeThat
}