@types/project-name-generator - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1

project-name-generator/index.d.ts

@@ -18,3 +18,3 @@ // Type definitions for project-name-generator 2.1
          */
-        words?: number;
+        words?: number | undefined;
         /**
@@ -24,3 +24,3 @@ * Whether a numeric suffix is generated or not. The number is between 1 - 9999, both inclusive.
          */
-        number?: boolean;
+        number?: boolean | undefined;
         /**
@@ -30,3 +30,3 @@ * Whether to output words beginning with the same letter or not
          */
-        alliterative?: boolean;
+        alliterative?: boolean | undefined;
     }
@@ -33,0 +33,0 @@ interface Project {

project-name-generator/package.json

 {
     "name": "@types/project-name-generator",
-    "version": "2.1.0",
+    "version": "2.1.1",
     "description": "TypeScript definitions for project-name-generator",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/project-name-generator",
     "license": "MIT",
@@ -22,4 +23,4 @@ "contributors": [
     "dependencies": {},
-    "typesPublisherContentHash": "fa76cbb97361c061acad69201b146e7c8e65ee4a53e56dcdd6d2970b18ba6d9a",
-    "typeScriptVersion": "3.0"
+    "typesPublisherContentHash": "2c721083915d7eb093940872ac5ea7f126b0b08e0698b044edf6386fdcd1a19e",
+    "typeScriptVersion": "3.6"
 }

project-name-generator/README.md

@@ -9,5 +9,46 @@ # Installation
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/project-name-generator.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/project-name-generator/index.d.ts)
+````ts
+// Type definitions for project-name-generator 2.1
+// Project: https://github.com/aceakash/project-name-generator#readme
+// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
+/**
+ * Generate quirky names like spiffy-waterfall, sassy-bread, mature-dew-8239 to use wherever you need a random but memorable name.
+ */
+declare function generate(options?: generate.Options): generate.Project;
+
+declare namespace generate {
+    interface Options {
+        /**
+         * Number of words generated (excluding number).
+         * All words will be adjectives, except the last one which will be a noun
+         * @default 2
+         */
+        words?: number | undefined;
+        /**
+         * Whether a numeric suffix is generated or not. The number is between 1 - 9999, both inclusive.
+         * @default false
+         */
+        number?: boolean | undefined;
+        /**
+         * Whether to output words beginning with the same letter or not
+         * @default false
+         */
+        alliterative?: boolean | undefined;
+    }
+    interface Project {
+        raw: Array<string | number>;
+        dashed: string;
+        spaced: string;
+    }
+}
+
+export = generate;
+
+````
+
 ### Additional Details
- * Last updated: Tue, 16 Jun 2020 09:55:55 GMT
+ * Last updated: Thu, 08 Jul 2021 20:19:52 GMT
  * Dependencies: none
@@ -14,0 +55,0 @@ * Global values: none

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5231

41.72%

Number of low quality alerts

0

-100%

Number of lines in readme file

58

241.18%

No dependency changes