Installation

npm install --save @types/inflected

Summary

This package contains type definitions for inflected (https://github.com/martinandert/inflected).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/inflected.

index.d.ts

1export interface Humanize {
2    capitalize?: boolean;
3}
4
5export interface Parameterize {
6    preserveCase?: boolean;
7    separator?: string;
8}
9
10export interface Transliterate {
11    locale?: string;
12    replacement?: string;
13}
14
15export interface Inflections {
16    acronym(word: string): void;
17    plural(rule: RegExp, replacement: string): void;
18    plural(rule: string): void;
19    singular(rule: RegExp, replacement: string): void;
20    singular(rule: string): void;
21    irregular(singular: string, plural: string): void;
22    uncountable(...words: string[]): void;
23    human(rule: RegExp | string, replacement: string): void;
24    clear(scope?: string): void;
25}
26
27export interface Transliterations {
28    approximate(original: string, replacement: string): void;
29}
30
31export function pluralize(word: string, locale?: string): string;
32export function singularize(word: string, locale?: string): string;
33export function camelize(term: string, uppercaseFirstLetter?: boolean): string;
34export function underscore(camelCaseWord: string): string;
35export function humanize(lowerCaseAndUnderscoredWord: string, options?: Humanize): string;
36export function titleize(sentence: string): string;
37export function tableize(className: string): string;
38export function classify(tableName: string): string;
39export function dasherize(underscoredWord: string): string;
40export function foreignKey(className: string, separateClassNameAndIdWithUnderscore?: boolean): string;
41export function ordinal(number: number): string;
42export function ordinalize(number: number): string;
43export function inflections(locale: string, inflect?: (inflect: Inflections) => void): void;
44export function inflections(inflect?: (inflect: Inflections) => void): void;
45export function transliterate(sentence: string, options?: Transliterate): string;
46export function transliterations(locale: string, transliterate?: (transliterate: Transliterations) => void): void;
47export function transliterations(transliterate?: (transliterate: Transliterations) => void): void;
48export function parameterize(sentence: string, options?: Parameterize): string;
49export function constantify(words: string): string;
50export function capitalize(word?: string | null): string;
51
52export as namespace Inflector;
53

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: none

Credits

These definitions were written by Daniel Schmidt, and Jon Clerck.