@travetto/test/src/model/common.ts

Declarative test framework

/** Configuration of a skip */
export type Skip = boolean | ((instance: unknown) => boolean | Promise<boolean>);

/**
 * Core Suite definition
 */
export interface SuiteCore {
  /**
   * The class id
   */
  classId: string;
  /**
   * The tests' description
   */
  description: string;
  /**
   * The import location for the suite
   */
  import: string;
  /**
   * The first line of the unit
   */
  lineStart: number;
  /**
   * The last line of the unit
   */
  lineEnd: number;
  /**
   * Tags for a suite or a test
   */
  tags?: string[];
}

/**
 * Test core definition, adds start of body
 */
export interface TestCore extends SuiteCore {
  /**
   * The first line of the unit body
   */
  lineBodyStart: number;
  /**
   * For extended suites, this is location of the actual file where the test exists
   */
  sourceImport?: string;
}