5 |
4 |
5 |
${htmlEscaper.replace(pre)}${htmlEscaper.replace(code)}`
110 | }],
111 |
112 | // Subsequent replaces are performed only outside code blocks and spans.
113 | [/[*~=+_-`]+/, '$&'],
114 | [/\n/, '_Markdown_ within fenced code blocks is not *processed*: 138 | ``` 139 | Even embedded "fence strings" work well with **UnionEscaper** 140 | ``` 141 |
${htmlEscaper.replace(pre)}${myHtmlEscape.replace(code)}`
243 | } else if (special) {
244 | return `${special}`
245 | } else if (nl) {
246 | return 'Create a UnionReplacer instance performing the specified replaces.
10 | * @example 11 | * replacer = new UnionReplacer([[/\$foo\b/, 'bar'], [/\\(.)/, '$1']]); 12 | * @example 13 | * // Simple URI encoder 14 | * replacer = new UnionReplacer([ 15 | * [/ /, '+'], 16 | * [/[^\w.,-]/, (m) => `%${m.charCodeAt(0).toString(16)}`], 17 | * ]); 18 | * @example 19 | * replacer = new UnionReplacer([[/\$foo\b/, 'bar'], [/\\(.)/, '$1']], 'gi'); 20 | * @param replaces -Replaces to be performed
21 | * specified as an array of {@link UnionReplacer.ReplaceTuple} array tuples.
22 | * The order of elements in replaces is important: if any pattern is matched,
23 | * the corresponding amount of input is consumed and subsequent patterns
24 | * will not match on such part of the input.
Flags for replacement, defaults to 'gm'.
26 | */ 27 | declare class UnionReplacer { 28 | constructor(replaces: UnionReplacer.ReplaceTuple[], flags?: string); 29 | readonly flags: string; 30 | /** 31 | *Build the underlying combined regular expression. This method has no effect 32 | * since v2.0, as the builder-like functionality has been removed and underlying 33 | * data structures are prepared in the constructor.
34 | */ 35 | compile(): void; 36 | /** 37 | *Perform search and replace with the combined patterns and use corresponding 38 | * replacements for the particularly matched patterns.
39 | * @param subject -Input to search and process.
40 | * @param [userCtx = {}] -User-provided context to be passed as this
41 | * when calling replacement functions and as a parameter of the builder calls.
New string with the matches replaced. Or any type when a 43 | * custom builder is provided.
44 | */ 45 | replace(subject: string, userCtx?: any): string; 46 | /** 47 | *Perform search and replace with the combined patterns and use corresponding 48 | * replacements for the particularly matched patterns. Pass the resulting chunks 49 | * to an user-provided {@link UnionReplacer.ReplacementBuilder} instead of 50 | * concatenating them into one string.
51 | * @example 52 | * replacer.replace('foo'); 53 | * @param subject -Input to search and process.
54 | * @param userCtx -User-provided context to be passed as this when
55 | * calling replacement functions and as a parameter of the builder calls.
Collects and builds 57 | * the result from unmatched subject slices and replaced matches. A custom 58 | * builder allows for creating arbitrary structures based on matching or 59 | * streaming these chunks without building any output.
60 | * @returnsResult built by the builder.
61 | */ 62 | replaceEncapsulation of matcher variables.
68 | */ 69 | interface MatchingContext { 70 | /** 71 | *The {@link UnionReplacer} instance being used.
72 | */ 73 | replacer: UnionReplacer; 74 | /** 75 | *Last match, as returned by {@link RegExp#exec}.
76 | */ 77 | match: RegExpExecArray | null; 78 | /** 79 | *Advance matching position n characters after the match end position.
Number of characters to skip. Zero and negative values 81 | * are valid, but introduce risk of infinite processing. It is then user 82 | * responsibility to prevent it.
83 | */ 84 | skip(n: number): void; 85 | /** 86 | *Set matching position to n characters from match start.
Number of characters jump. Values less than or equal 88 | * to match length are valid, but introduce risk of infinite processing. 89 | * It is then user responsibility to prevent it.
90 | */ 91 | jump(n: number): void; 92 | /** 93 | *Reset matching position according to standard regexp match position advancing.
94 | */ 95 | reset(): void; 96 | /** 97 | *Determine whether the current match is at the input start.
98 | * @returnstrue if current match is at input start, false otherwise.
Determine whether the current match is at the input end.
103 | * @returnstrue if current match is at input end, false otherwise.
Replacement callback function, as defined for String.prototype.replace.
Extended replacement callback function that provides more options during processing.
113 | */ 114 | type ExtendedReplaceCb = (ctx: UnionReplacer.MatchingContext) => string; 115 | /** 116 | *Particular replace with ECMAScript string replacement.
117 | * @property 0 -Particular regexp to match.
118 | * @property 1 -Replacement string, as defined for String.prototype.replace.
Particular replace with ECMAScript callback replacement.
123 | * @property 0 -Particular regexp to match.
124 | * @property 1 -Replacement callback, as defined for String.prototype.replace.
Particular replace with extended callback replacement (UnionReplacer specific).
129 | * @property 0 -Particular regexp to match.
130 | * @property 1 -Replacement callback accepting 131 | * {@link UnionReplacer.MatchingContext}.
132 | * @property 2 -Flag true marking the callback as {@link UnionReplacer.ExtendedReplaceCb}.
Particular replace with explicitly set ECMAScript callback replacement. 137 | * Leads to the same behavior as {@link UnionReplacer.ReplaceWithCb}.
138 | * @property 0 -Particular regexp to match.
139 | * @property 1 -Replacement callback accepting 140 | * {@link UnionReplacer.MatchingContext}.
141 | * @property 2 -Flag false marking the callback as {@link UnionReplacer.StringReplaceCb}.
Particular replace definition similiar to {@link String#replace} arguments specified 146 | * as an array (tuple) with the following items:
147 | *$<name>.
155 | * Replacement function is by default the {@link String#replace}-style callback:(match, p1, ..., pn, offset, string, namedCaptures) => { ... }.
161 | * Unlike numbered captures that are narrowed for the particular match,
162 | * this extra namedCaptures parameter would contain keys for all the named
163 | * capture groups within the replacer and the values of "foreign" named captures
164 | * would be always undefined.
165 | * Replacement callback can also be specified as extended. Then only one
166 | * parameter is passed, an instance of {@link UnionReplacer.MatchingContext}.
167 | * This variant is more powerful.extended flag - if true, the {@link UnionReplacer.MatchingContext}
171 | * will be passed to the replacement function instead of {@link String#replace}-ish
172 | * parameters.Interface for processors of string chunks during replacement process.
178 | */ 179 | interface ReplacementBuilderProcess unmatched slice of the input string.
182 | * @example 183 | * builder.addSubjectSlice('example', 1, 2); 184 | * @param subject -String to be processed.
185 | * @param start -Zero-based index at which to begin extraction.
186 | * @param end -Zero-based index before which to end extraction. 187 | * The character at this index will not be included.
188 | */ 189 | addSubjectSlice(subject: string, start: number, end: number): void; 190 | /** 191 | *Process replaced match.
192 | * @example 193 | * builder.addReplacedString('example'); 194 | * @param string -String to be processed.
195 | */ 196 | addReplacedString(string: string): void; 197 | /** 198 | *Build output to be returned by {@link UnionReplacer#replace(2)}.
199 | * @example 200 | * const x = builder.build(); 201 | * @returnsOutput to be returned by {@link UnionReplacer#replace(2)}.
202 | */ 203 | build(): T; 204 | } 205 | } 206 | -------------------------------------------------------------------------------- /types/test.ts: -------------------------------------------------------------------------------- 1 | import UnionReplacer = require('union-replacer'); 2 | 3 | new UnionReplacer([]); 4 | new UnionReplacer(); // $ExpectError 5 | new UnionReplacer([/foo/, 'bar']); // $ExpectError 6 | new UnionReplacer([['foo', 'bar']]); // $ExpectError 7 | 8 | new UnionReplacer([[/foo/, 'bar']]); 9 | new UnionReplacer([[/foo/, 'bar', true]]); // $ExpectError 10 | new UnionReplacer([[/foo/, 'bar', false]]); // $ExpectError 11 | 12 | new UnionReplacer([[/foo/, (m: string, index: number): string => '']]); 13 | new UnionReplacer([[/foo/, (m: string, index: number): number => 1]]); // $ExpectError 14 | new UnionReplacer([[/foo/, (m: string): string => m, false]]); 15 | new UnionReplacer([[/foo/, (m: string): string => m, true]]); // $ExpectError 16 | 17 | new UnionReplacer([[/foo/, (ctx: UnionReplacer.MatchingContext): string => '', true]]); 18 | new UnionReplacer([[/foo/, (ctx: UnionReplacer.MatchingContext): number => 1, true]]); // $ExpectError 19 | new UnionReplacer([[/foo/, (ctx: UnionReplacer.MatchingContext): string => '', false]]); // $ExpectError 20 | 21 | const replacer: UnionReplacer = new UnionReplacer([ 22 | [/foo/, (m, index) => { 23 | m; // $ExpectType string 24 | return ''; 25 | }], 26 | [/bar/, (ctx: UnionReplacer.MatchingContext) => { 27 | ctx; // $ExpectType MatchingContext 28 | ctx.match; // $ExpectType RegExpExecArray | null 29 | return ''; 30 | }, true], 31 | ]); 32 | 33 | replacer.replace('foobar'); // $ExpectType string 34 | 35 | class MyBuilder implements UnionReplacer.ReplacementBuilder