@types/inflected - npm Package Compare versions

Comparing version 2.1.1 to 2.1.2

inflected/index.d.ts

@@ -1,7 +0,1 @@
-// Type definitions for inflected 2.1
-// Project: https://github.com/martinandert/inflected
-// Definitions by: Daniel Schmidt <https://github.com/dsci>
-//                 Jon Clerck <https://github.com/Jclerck>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
 export interface Humanize {
@@ -8,0 +2,0 @@ capitalize?: boolean;

inflected/package.json

 {
     "name": "@types/inflected",
-    "version": "2.1.1",
+    "version": "2.1.2",
     "description": "TypeScript definitions for inflected",
@@ -10,9 +10,9 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/inflected",
             "name": "Daniel Schmidt",
-            "url": "https://github.com/dsci",
-            "githubUsername": "dsci"
+            "githubUsername": "dsci",
+            "url": "https://github.com/dsci"
         },
         {
             "name": "Jon Clerck",
-            "url": "https://github.com/Jclerck",
-            "githubUsername": "Jclerck"
+            "githubUsername": "Jclerck",
+            "url": "https://github.com/Jclerck"
         }
@@ -29,4 +29,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "8cf8816ab71f4f98cc98df7cc3efaaa9d06f90504a19c933027f3b3c8a757412",
+    "typesPublisherContentHash": "85943b5b3d8ac19529ac40784e0cbe842dd582952eb7adebaa31bdc8059e0f0e",
     "typeScriptVersion": "4.5"
 }

inflected/README.md

@@ -9,9 +9,64 @@ # Installation
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/inflected.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/inflected/index.d.ts)
+````ts
+export interface Humanize {
+    capitalize?: boolean;
+}
 
+export interface Parameterize {
+    preserveCase?: boolean;
+    separator?: string;
+}
+
+export interface Transliterate {
+    locale?: string;
+    replacement?: string;
+}
+
+export interface Inflections {
+    acronym(word: string): void;
+    plural(rule: RegExp, replacement: string): void;
+    plural(rule: string): void;
+    singular(rule: RegExp, replacement: string): void;
+    singular(rule: string): void;
+    irregular(singular: string, plural: string): void;
+    uncountable(...words: string[]): void;
+    human(rule: RegExp | string, replacement: string): void;
+    clear(scope?: string): void;
+}
+
+export interface Transliterations {
+    approximate(original: string, replacement: string): void;
+}
+
+export function pluralize(word: string, locale?: string): string;
+export function singularize(word: string, locale?: string): string;
+export function camelize(term: string, uppercaseFirstLetter?: boolean): string;
+export function underscore(camelCaseWord: string): string;
+export function humanize(lowerCaseAndUnderscoredWord: string, options?: Humanize): string;
+export function titleize(sentence: string): string;
+export function tableize(className: string): string;
+export function classify(tableName: string): string;
+export function dasherize(underscoredWord: string): string;
+export function foreignKey(className: string, separateClassNameAndIdWithUnderscore?: boolean): string;
+export function ordinal(number: number): string;
+export function ordinalize(number: number): string;
+export function inflections(locale: string, inflect?: (inflect: Inflections) => void): void;
+export function inflections(inflect?: (inflect: Inflections) => void): void;
+export function transliterate(sentence: string, options?: Transliterate): string;
+export function transliterations(locale: string, transliterate?: (transliterate: Transliterations) => void): void;
+export function transliterations(transliterate?: (transliterate: Transliterations) => void): void;
+export function parameterize(sentence: string, options?: Parameterize): string;
+export function constantify(words: string): string;
+export function capitalize(word?: string | null): string;
+
+export as namespace Inflector;
+
+````
+
 ### Additional Details
- * Last updated: Tue, 26 Sep 2023 14:36:22 GMT
+ * Last updated: Wed, 18 Oct 2023 01:17:35 GMT
  * Dependencies: none
- * Global values: `Inflector`
 
 # Credits
 These definitions were written by [Daniel Schmidt](https://github.com/dsci), and [Jon Clerck](https://github.com/Jclerck).

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

7189

increased by39.86%

Number of downloads

20046

increased by13.54%

Number of lines in readme file

72

increased by323.53%

Worsened metrics

Lines of code

46

decreased by-9.8%

No dependency changes