@types/hepburn - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

hepburn/index.d.ts

@@ -1,6 +0,1 @@
-// Type definitions for hepburn 1.2
-// Project: https://github.com/lovell/hepburn#readme
-// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
 /**
@@ -7,0 +2,0 @@ * Converts a string containing Kana, either Hiragana or Katakana, to Romaji.

hepburn/package.json

 {
     "name": "@types/hepburn",
-    "version": "1.2.0",
+    "version": "1.2.1",
     "description": "TypeScript definitions for hepburn",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hepburn",
     "license": "MIT",
@@ -9,4 +10,4 @@ "contributors": [
             "name": "Piotr Błażejewicz",
-            "url": "https://github.com/peterblazejewicz",
-            "githubUsername": "peterblazejewicz"
+            "githubUsername": "peterblazejewicz",
+            "url": "https://github.com/peterblazejewicz"
         }
@@ -23,4 +24,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "7be111c63f7d0223b7c5eef1143ee8ceb3323577f1ab9f591ad2982c8c60851e",
-    "typeScriptVersion": "3.2"
+    "typesPublisherContentHash": "4bec06875142e31a387226066ff96d153b4e10fbb711d0c0abd1b98df43e61dd",
+    "typeScriptVersion": "4.5"
 }

hepburn/README.md

@@ -9,9 +9,63 @@ # Installation
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hepburn.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hepburn/index.d.ts)
+````ts
+/**
+ * Converts a string containing Kana, either Hiragana or Katakana, to Romaji.
+ */
+export function fromKana(str: string): string;
 
+/**
+ * Converts a string containing Romaji to Hiragana.
+ */
+export function toHiragana(str: string): string;
+
+/**
+ * Converts a string containing Romaji to Katakana.
+ */
+export function toKatakana(str: string): string;
+
+/**
+ * Cleans up a romaji string, changing old romaji forms into the more-modern Hepburn form (for further processing).
+ * Generally matches the style used by Wapro romaji.
+ * A larger guide to modern romaji conventions was used in building this method.
+ */
+export function cleanRomaji(str: string): string;
+
+/**
+ * Splits a `str` containing Katakana or Hiragana into a syllables array.
+ */
+export function splitKana(str: string): string[];
+
+/**
+ * Splits a `str` containing Romaji into a syllables array.
+ */
+export function splitRomaji(str: string): string[];
+
+/**
+ * Returns true if `str` contains Hiragana.
+ */
+export function containsHiragana(str: string): boolean;
+
+/**
+ * Returns true if `str` contains Katakana.
+ */
+export function containsKatakana(str: string): boolean;
+
+/**
+ * Returns true if `str` contains any Kana.
+ */
+export function containsKana(str: string): boolean;
+
+/**
+ * Returns true if `str` contains any Kanji.
+ */
+export function containsKanji(str: string): boolean;
+
+````
+
 ### Additional Details
- * Last updated: Tue, 29 Sep 2020 20:55:17 GMT
+ * Last updated: Wed, 18 Oct 2023 01:17:35 GMT
  * Dependencies: none
- * Global values: none
 
 # Credits
 These definitions were written by [Piotr Błażejewicz](https://github.com/peterblazejewicz).

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5250

33.11%

Number of low quality alerts

0

-100%

Number of lines in readme file

71

317.65%

Worsened metrics

Lines of code

42

-8.7%

No dependency changes