capitalise

Capitalises the first letter of one word, or all words, in a string.

NOTE

tsu also exports this function as capitalize

Usage

ts

import { capitalise } from 'tsu'

capitalise('ribbit ribbit')
// 'Ribbit ribbit'

capitalise('ribbit ribbit', true)
// 'Ribbit Ribbit'

capitalise('ribbit/ribbit', true, '/')
// 'Ribbit/Ribbit'

Type Definitions

ts

/**
 * @param str - The string.
 * @param allWords - If all words should be capitalised.
 * @param delimiter - The delimiter to split the string by.
 * @returns The capitalised string.
 */
function capitalise(str: string, allWords = false, delimiter = ' '): string