UNPKG

1.87 kBTypeScriptView Raw
1/// <reference types="node" />
2import { AllureRuntime } from "./AllureRuntime";
3import { AllureTest } from "./AllureTest";
4import { ExecutableItemWrapper } from "./ExecutableItemWrapper";
5import { AttachmentOptions, Category, Status } from "./model";
6import { ContentType } from "./model";
7export declare abstract class Allure {
8 protected runtime: AllureRuntime;
9 protected abstract get currentTest(): AllureTest;
10 protected abstract get currentExecutable(): ExecutableItemWrapper;
11 protected constructor(runtime: AllureRuntime);
12 epic(epic: string): void;
13 feature(feature: string): void;
14 story(story: string): void;
15 suite(name: string): void;
16 parentSuite(name: string): void;
17 subSuite(name: string): void;
18 label(name: string, value: string): void;
19 parameter(name: string, value: string): void;
20 link(url: string, name?: string, type?: string): void;
21 issue(name: string, url: string): void;
22 tms(name: string, url: string): void;
23 description(markdown: string): void;
24 descriptionHtml(html: string): void;
25 owner(owner: string): void;
26 severity(severity: string): void;
27 tag(tag: string): void;
28 writeEnvironmentInfo(info: Record<string, string>): void;
29 writeCategoriesDefinitions(categories: Category[]): void;
30 abstract attachment(name: string, content: Buffer | string, options: ContentType | string | AttachmentOptions): void;
31 abstract logStep(name: string, status?: Status): void;
32 abstract step<T>(name: string, body: (step: StepInterface) => T): T;
33 createStep(name: string, stepFunction: Function): (...args: any[]) => any;
34 createAttachment(name: string, content: Buffer | string | Function, type: ContentType): ((...args: any[]) => void) | undefined;
35}
36export interface StepInterface {
37 parameter(name: string, value: string): void;
38 name(name: string): void;
39}