speech-code - npm Package Compare versions

Comparing version 1.3.1 to 1.3.2

index.d.ts

@@ -1,27 +0,29 @@
-// Type definitions for speech-code 1.3.0
-// Project: https://github.com/mamoruuu/speech-code
-// Definitions by: Alexander B. <https://github.com/mamoruuu>
-// Definitions: https://github.com/mamoruuu/speech-code
+/*
+Type definitions for speech-code 1.3.2
+Project: https://github.com/mamoruuu/speech-code
+Definitions by: Alexander Bolotskov <https://github.com/mamoruuu>
+Definitions: https://github.com/mamoruuu/speech-code
+*/
 
-export namespace SpeechCode {
-  /**
-   * Returns a text consisting of given number of paragraphs
-   * consisting of random number of sentences (from 2 to 5)
-   * @param paragraphs - the number of paragraphs in the text
-   */
-  export function getText(paragraphs?: number = 3): string;
-  /**
-   * Returns a paragraph consisting of given number of sentences
-   * @param sentences - the number of sentences
-   */
-  export function getParagraph(sentences?: number = 3): string;
-  /**
-   * Returns a single generated sentence
-   */
-  export function getSentence(): string;
-  /**
-   * Returns a paragraph with specified number of characters
-   * @param chars - the number of characters (spaces included)
-   */
-  export function getCharacters(chars?: number = 50): string;
-}
+/**
+ * Returns a text consisting of given number of paragraphs
+ * consisting of random number of sentences (from 2 to 5)
+ * @param paragraphs - the number of paragraphs in the text. Default is 3.
+ */
+export function getText(paragraphs?: number): string;
+/**
+ * Returns a paragraph consisting of given number of sentences
+ * @param sentences - the number of sentences. Default is 3.
+ */
+export function getParagraph(sentences?: number): string;
+/**
+ * Returns a single generated sentence
+ */
+export function getSentence(): string;
+/**
+ * Returns a paragraph with specified number of characters.
+ *
+ * *WARNING: The length of the resulting text will never be equal to specified value. It might be either shorter or longer.*
+ * @param chars - the number of characters (spaces included). Default is 50.
+ */
+export function getCharacters(chars?: number): string;

index.js

@@ -0,0 +0,0 @@ "use strict";

LICENSE.md

@@ -0,0 +0,0 @@ MIT License

package.json

@@ -19,7 +19,9 @@ {
     },
-    "version": "1.3.1",
+    "version": "1.3.2",
     "main": "index.js",
     "license": "MIT",
     "types": "index.d.ts",
-    "bin": "bin/speech-code",
+    "bin": {
+        "speech-code": "bin/speech-code"
+    },
     "devDependencies": {
@@ -26,0 +28,0 @@ "prettier": "^2.2.0"

README.md

@@ -35,3 +35,3 @@ # Russian Speech Code
 npx speech-code sentence
-npx speech-code char 1000
+npx speech-code char 1000  # the length of resulting text will never be equal to specified value. It might be either shorter or longer
 
@@ -38,0 +38,0 @@ # You can also use shorter version of types

No alert changes

Improved metrics

Lines of code

188

increased by1.08%

Worsened metrics

Total package byte prevSize

12674

decreased by-0.9%

No dependency changes