Type Alias Replace<Input, Search, Replacement, Options>

Replace: Input extends `${infer Head}${Search}${infer Tail}`
    ? Options["all"] extends true
        ? `${Head}${Replacement}${Replace<Tail, Search, Replacement, Options>}`
        : `${Head}${Replacement}${Tail}`
    : Input

Represents a string with some or all matches replaced by a replacement.

Use-case:

snake-case-path to dotted.path.notation
Changing date/time format: 01-08-2042 → 01/08/2042
Manipulation of type properties, for example, removal of prefixes

Type Parameters

Input extends string
Search extends string
Replacement extends string
Options extends ReplaceOptions = {}

Example

import {Replace} from 'type-fest';

declare function replace<
	Input extends string,
	Search extends string,
	Replacement extends string
>(
	input: Input,
	search: Search,
	replacement: Replacement
): Replace<Input, Search, Replacement>;

declare function replaceAll<
	Input extends string,
	Search extends string,
	Replacement extends string
>(
	input: Input,
	search: Search,
	replacement: Replacement
): Replace<Input, Search, Replacement, {all: true}>;

// The return type is the exact string literal, not just `string`.

replace('hello ?', '?', '🦄');
//=> 'hello 🦄'

replace('hello ??', '?', '❓');
//=> 'hello ❓?'

replaceAll('10:42:00', ':', '-');
//=> '10-42-00'

replaceAll('__userName__', '__', '');
//=> 'userName'

replaceAll('My Cool Title', ' ', '');
//=> 'MyCoolTitle'

Type Alias Replace<Input, Search, Replacement, Options>

Type Parameters

Example

Settings