@types/allure-js-commons - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

allure-js-commons/index.d.ts

@@ -1,7 +0,1 @@
-// Type definitions for allure-js-commons 0.0
-// Project: https://github.com/allure-framework/allure-js
-// Definitions by: Denis Artyuhovich <https://github.com/zaqqaz>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.7
-
 declare class Allure {
@@ -8,0 +2,0 @@ constructor();

allure-js-commons/package.json

 {
     "name": "@types/allure-js-commons",
-    "version": "0.0.2",
+    "version": "0.0.3",
     "description": "TypeScript definitions for allure-js-commons",
@@ -10,4 +10,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/allure-js-commons",
             "name": "Denis Artyuhovich",
-            "url": "https://github.com/zaqqaz",
-            "githubUsername": "zaqqaz"
+            "githubUsername": "zaqqaz",
+            "url": "https://github.com/zaqqaz"
         }
@@ -24,4 +24,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "09aefb6c61b1455a7eef5beaaf047f26759ef3499a294577f40e3061b5c79d09",
+    "typesPublisherContentHash": "6d79e6509bc5a2149292e52f2243ddbd1379e7d49c20696fd51d2353ea7c6f95",
     "typeScriptVersion": "4.5"
 }

allure-js-commons/README.md

@@ -9,9 +9,117 @@ # Installation
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/allure-js-commons.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/allure-js-commons/index.d.ts)
+````ts
+declare class Allure {
+    constructor();
 
+    setOptions(options: Allure.Options): void;
+
+    getCurrentSuite(): Allure.Suite;
+
+    getCurrentTest(): Allure.Test;
+
+    startSuite(suiteName: string, timestamp?: number): void;
+
+    endSuite(timestamp?: number): void;
+
+    startCase(testName: string, timestamp?: number): void;
+
+    endCase(status: Allure.Status, err?: {}, timestamp?: number): void;
+
+    startStep(stepName: string, timestamp?: number): void;
+
+    endStep(status: Allure.Status, timestamp?: number): void;
+
+    setDescription(description: string, timestamp?: number): void;
+
+    addAttachment(attachmentName: string, buffer: any, type: string): void;
+
+    pendingCase(testName: string, timestamp?: number): void;
+}
+
+export = Allure;
+export as namespace Allure;
+declare namespace Allure {
+    interface Options {
+        targetDir: string;
+    }
+
+    type Status = "passed" | "pending" | "skipped" | "failed" | "broken";
+
+    enum TYPE {
+        TEXT = "text",
+        HTML = "html",
+        MARKDOWN = "markdown",
+    }
+
+    class Suite {
+        constructor(name: string, timestamp?: number);
+
+        name: string;
+
+        end(timestamp?: number): void;
+
+        hasTests(): boolean;
+
+        addTest(test: Test): boolean;
+
+        toXML(): string;
+    }
+
+    class Test {
+        constructor(name: string, timestamp?: number);
+
+        setDescription(description: string, type: TYPE): void;
+
+        addLabel(name: string, value: string): void;
+
+        addParameter(kind: any, name: string, value: string): void;
+
+        addStep(step: Step): void;
+
+        addAttachment(attachment: Attachment): void;
+
+        end(status: Status, error: Error, timestamp?: number): void;
+
+        toXML(): string;
+    }
+
+    class Description {
+        constructor(value: string, type: TYPE);
+
+        toXML(): string;
+    }
+
+    class Step {
+        constructor(name: string, timestamp?: number);
+
+        addStep(step: Step): void;
+
+        addAttachment(attachment: Attachment): void;
+
+        end(status: Status, error: Error, timestamp?: number): void;
+
+        toXML(): string;
+    }
+
+    class Attachment {
+        constructor(title: string, source: any, size: number, mime: string);
+
+        addStep(step: Step): void;
+
+        addAttachment(attachment: Attachment): void;
+
+        end(status: Status, error: Error, timestamp?: number): void;
+
+        toXML(): string;
+    }
+}
+
+````
+
 ### Additional Details
- * Last updated: Fri, 22 Sep 2023 18:11:03 GMT
+ * Last updated: Tue, 17 Oct 2023 22:10:13 GMT
  * Dependencies: none
- * Global values: `Allure`
 
 # Credits
 These definitions were written by [Denis Artyuhovich](https://github.com/zaqqaz).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7393

increased by43.25%

Number of lines in readme file

125

increased by635.29%

Worsened metrics

Lines of code

64

decreased by-7.25%

No dependency changes