mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
abb6102c14
* replacestream: new typings * replacestream: fix "Exceeds maximum line length of 200" * replacestream: use `export =` syntax
55 lines
1.7 KiB
TypeScript
55 lines
1.7 KiB
TypeScript
// Type definitions for replacestream 4.0
|
|
// Project: https://github.com/eugeneware/replacestream#readme
|
|
// Definitions by: Piotr Roszatycki <https://github.com/dex4er>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
declare namespace ReplaceStream {
|
|
interface Options {
|
|
/**
|
|
* Sets a limit on the number of times the replacement will be made. This
|
|
* is forced to one when a regex without the global flag is provided.
|
|
*
|
|
* Default: `Infinity`
|
|
*/
|
|
limit?: number;
|
|
/**
|
|
* The text encoding used during search and replace.
|
|
*
|
|
* Default: `"utf8"`
|
|
*/
|
|
encoding?: string;
|
|
/**
|
|
* When doing cross-chunk replacing, this sets the maximum length match
|
|
* that will be supported.
|
|
*
|
|
* Default: `100`
|
|
*/
|
|
maxMatchLen?: number;
|
|
/**
|
|
* When doing string match (not relevant for regex matching) whether to do a
|
|
* case insensitive search.
|
|
*
|
|
* Default: `true`
|
|
*/
|
|
ignoreCase?: boolean;
|
|
/**
|
|
* When provided, these flags will be used when creating the search regexes
|
|
* internally.
|
|
*
|
|
* @deprecated as the flags set on the regex provided are no longer mutated
|
|
* if this is not provided.
|
|
*/
|
|
regExpOptions?: string;
|
|
}
|
|
|
|
type ReplaceFunction = (match: string, p1: string, offset: number, string: string) => string;
|
|
}
|
|
|
|
declare function ReplaceStream(
|
|
search: RegExp | string,
|
|
replace: ReplaceStream.ReplaceFunction | string,
|
|
options?: ReplaceStream.Options
|
|
): any;
|
|
|
|
export = ReplaceStream;
|