Skip to main content

getSuite

codebolt.autoTesting.getSuite(params: IGetSuiteParams): Promise<IGetSuiteResponse>

Retrieves details of a specific test suite including its test cases.

Parameters​

Returns​

  • Promise<[IGetSuiteResponse](/docs/reference/type-reference/codeboltjs/interfaces/IGetSuiteResponse)>: A promise that resolves to the test suite with associated test cases.

Examples​

const suite = await codebolt.autoTesting.getSuite({ id: 'suite-123' });
console.log('Suite:', suite.payload.suite);
console.log('Test cases:', suite.payload.testCases);

Notes​

  • Returns suite details and all test cases
  • Useful for suite inspection
  • Includes case details for planning