import type { ApplyDefaultOptions, IsNumeric, WordSeparators, } from './internal/index.d.ts'; import type {IsLowercase} from './is-lowercase.d.ts'; import type {IsUppercase} from './is-uppercase.d.ts'; type SkipEmptyWord = Word extends '' ? [] : [Word]; type RemoveLastCharacter< Sentence extends string, Character extends string, > = Sentence extends `${infer LeftSide}${Character}` ? SkipEmptyWord : never; /** Words options. @see {@link Words} */ export type WordsOptions = { /** Split on numeric sequence. @default true @example ``` type Example1 = Words<'p2pNetwork', {splitOnNumbers: true}>; //=> ["p", "2", "p", "Network"] type Example2 = Words<'p2pNetwork', {splitOnNumbers: false}>; //=> ["p2p", "Network"] ``` */ splitOnNumbers?: boolean; }; export type _DefaultWordsOptions = { splitOnNumbers: true; }; /** Split a string (almost) like Lodash's `_.words()` function. - Split on each word that begins with a capital letter. - Split on each {@link WordSeparators}. - Split on numeric sequence. @example ``` import type {Words} from 'type-fest'; type Words0 = Words<'helloWorld'>; //=> ['hello', 'World'] type Words1 = Words<'helloWORLD'>; //=> ['hello', 'WORLD'] type Words2 = Words<'hello-world'>; //=> ['hello', 'world'] type Words3 = Words<'--hello the_world'>; //=> ['hello', 'the', 'world'] type Words4 = Words<'lifeIs42'>; //=> ['life', 'Is', '42'] type Words5 = Words<'p2pNetwork', {splitOnNumbers: false}>; //=> ['p2p', 'Network'] ``` @category Change case @category Template literal */ export type Words = WordsImplementation>; type WordsImplementation< Sentence extends string, Options extends Required, LastCharacter extends string = '', CurrentWord extends string = '', > = Sentence extends `${infer FirstCharacter}${infer RemainingCharacters}` ? FirstCharacter extends WordSeparators // Skip word separator ? [...SkipEmptyWord, ...WordsImplementation] : LastCharacter extends '' // Fist char of word ? WordsImplementation // Case change: non-numeric to numeric : [false, true] extends [IsNumeric, IsNumeric] ? Options['splitOnNumbers'] extends true // Split on number: push word ? [...SkipEmptyWord, ...WordsImplementation] // No split on number: concat word : WordsImplementation // Case change: numeric to non-numeric : [true, false] extends [IsNumeric, IsNumeric] ? Options['splitOnNumbers'] extends true // Split on number: push word ? [...SkipEmptyWord, ...WordsImplementation] // No split on number: concat word : WordsImplementation // No case change: concat word : [true, true] extends [IsNumeric, IsNumeric] ? WordsImplementation // Case change: lower to upper, push word : [true, true] extends [IsLowercase, IsUppercase] ? [...SkipEmptyWord, ...WordsImplementation] // Case change: upper to lower, brings back the last character, push word : [true, true] extends [IsUppercase, IsLowercase] ? [...RemoveLastCharacter, ...WordsImplementation] // No case change: concat word : WordsImplementation : [...SkipEmptyWord]; export {};