@types/humanize-plus
Version:
TypeScript definitions for humanize-plus
45 lines (36 loc) • 1.96 kB
Markdown
# Installation
> `npm install --save @types/humanize-plus`
# Summary
This package contains type definitions for humanize-plus (https://github.com/HubSpot/humanize).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/humanize-plus.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/humanize-plus/index.d.ts)
````ts
// Numbers
export function formatNumber(number: number, decimals?: number): string;
export function intComma(number: number, decimals?: number): string;
export function compactInteger(number: number, decimals?: number): string;
export function boundedNumber(number: number, bounds?: number, ending?: string): string;
export function ordinal(value: number): string;
export function times(value: number, overrides?: any): string;
export function pace(value: number, intervalMs: number, unit?: string): string;
export function fileSize(filesize: number, precision?: number): string;
export function pluralize(number: number, singular?: string, plural?: string): string;
// Strings
export function truncate(string: string, length?: number, ending?: string): string;
export function truncateWords(string: string, length?: number): string | null;
export function capitalize(string: string, downCaseTail?: boolean): string;
export function capitalizeAll(string: string): string;
export function titleCase(string: string): string;
// Arrays
export function oxford(items: any[], limit?: number, limitStr?: string): string;
export function frequency(list: any[], verb?: string): string;
// Utility methods
export function toFixed(value: number, precision?: number): string;
export function normalizePrecision(value: number, base?: number): number;
````
### Additional Details
* Last updated: Tue, 07 Nov 2023 03:09:37 GMT
* Dependencies: none
# Credits
These definitions were written by [Denis Carriere](https://github.com/DenisCarriere).