@rolldown/pluginutils 1.0.0-beta.14-commit.12b8061 → 1.0.0-beta.16

package/dist/index.cjs

@@ -197,6 +197,18 @@ function exprInterpreter(expr, code$1, id$1, moduleType$1, ctx = {}) {
 *
 * @param str the string to match.
 * @param flags flags for the RegExp.
+*
+* @example
+* ```ts
+* import { exactRegex } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   resolveId: {
+*     filter: { id: exactRegex('foo') },
+*     handler(id) {} // will only be called for `foo`
+*   }
+* }
+* ```
 */
 function exactRegex(str, flags) {
 	return new RegExp(`^${escapeRegex(str)}$`, flags);
@@ -208,6 +220,18 @@ function exactRegex(str, flags) {
 *
 * @param str the string to match.
 * @param flags flags for the RegExp.
+*
+* @example
+* ```ts
+* import { prefixRegex } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   resolveId: {
+*     filter: { id: prefixRegex('foo') },
+*     handler(id) {} // will only be called for IDs starting with `foo`
+*   }
+* }
+* ```
 */
 function prefixRegex(str, flags) {
 	return new RegExp(`^${escapeRegex(str)}`, flags);

package/dist/index.d.cts

@@ -99,6 +99,18 @@ declare function exprInterpreter(expr: FilterExpression, code?: string, id?: str
 *
 * @param str the string to match.
 * @param flags flags for the RegExp.
+*
+* @example
+* ```ts
+* import { exactRegex } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   resolveId: {
+*     filter: { id: exactRegex('foo') },
+*     handler(id) {} // will only be called for `foo`
+*   }
+* }
+* ```
 */
 declare function exactRegex(str: string, flags?: string): RegExp;
 /**
@@ -108,6 +120,18 @@ declare function exactRegex(str: string, flags?: string): RegExp;
 *
 * @param str the string to match.
 * @param flags flags for the RegExp.
+*
+* @example
+* ```ts
+* import { prefixRegex } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   resolveId: {
+*     filter: { id: prefixRegex('foo') },
+*     handler(id) {} // will only be called for IDs starting with `foo`
+*   }
+* }
+* ```
 */
 declare function prefixRegex(str: string, flags?: string): RegExp;
 type WidenString<T> = T extends string ? string : T;
@@ -115,6 +139,25 @@ type WidenString<T> = T extends string ? string : T;
 * Converts a id filter to match with an id with a query.
 *
 * @param input the id filters to convert.
+*
+* @example
+* ```ts
+* import { makeIdFiltersToMatchWithQuery } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   transform: {
+*     filter: { id: makeIdFiltersToMatchWithQuery(['**' + '/*.js', /\.ts$/]) },
+*     // The handler will be called for IDs like:
+*     // - foo.js
+*     // - foo.js?foo
+*     // - foo.txt?foo.js
+*     // - foo.ts
+*     // - foo.ts?foo
+*     // - foo.txt?foo.ts
+*     handler(code, id) {}
+*   }
+* }
+* ```
 */
 declare function makeIdFiltersToMatchWithQuery<T extends string | RegExp>(input: T): WidenString<T>;
 declare function makeIdFiltersToMatchWithQuery<T extends string | RegExp>(input: readonly T[]): WidenString<T>[];

package/dist/index.d.ts

@@ -99,6 +99,18 @@ declare function exprInterpreter(expr: FilterExpression, code?: string, id?: str
 *
 * @param str the string to match.
 * @param flags flags for the RegExp.
+*
+* @example
+* ```ts
+* import { exactRegex } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   resolveId: {
+*     filter: { id: exactRegex('foo') },
+*     handler(id) {} // will only be called for `foo`
+*   }
+* }
+* ```
 */
 declare function exactRegex(str: string, flags?: string): RegExp;
 /**
@@ -108,6 +120,18 @@ declare function exactRegex(str: string, flags?: string): RegExp;
 *
 * @param str the string to match.
 * @param flags flags for the RegExp.
+*
+* @example
+* ```ts
+* import { prefixRegex } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   resolveId: {
+*     filter: { id: prefixRegex('foo') },
+*     handler(id) {} // will only be called for IDs starting with `foo`
+*   }
+* }
+* ```
 */
 declare function prefixRegex(str: string, flags?: string): RegExp;
 type WidenString<T> = T extends string ? string : T;
@@ -115,6 +139,25 @@ type WidenString<T> = T extends string ? string : T;
 * Converts a id filter to match with an id with a query.
 *
 * @param input the id filters to convert.
+*
+* @example
+* ```ts
+* import { makeIdFiltersToMatchWithQuery } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   transform: {
+*     filter: { id: makeIdFiltersToMatchWithQuery(['**' + '/*.js', /\.ts$/]) },
+*     // The handler will be called for IDs like:
+*     // - foo.js
+*     // - foo.js?foo
+*     // - foo.txt?foo.js
+*     // - foo.ts
+*     // - foo.ts?foo
+*     // - foo.txt?foo.ts
+*     handler(code, id) {}
+*   }
+* }
+* ```
 */
 declare function makeIdFiltersToMatchWithQuery<T extends string | RegExp>(input: T): WidenString<T>;
 declare function makeIdFiltersToMatchWithQuery<T extends string | RegExp>(input: readonly T[]): WidenString<T>[];

package/dist/index.js

@@ -196,6 +196,18 @@ function exprInterpreter(expr, code$1, id$1, moduleType$1, ctx = {}) {
 *
 * @param str the string to match.
 * @param flags flags for the RegExp.
+*
+* @example
+* ```ts
+* import { exactRegex } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   resolveId: {
+*     filter: { id: exactRegex('foo') },
+*     handler(id) {} // will only be called for `foo`
+*   }
+* }
+* ```
 */
 function exactRegex(str, flags) {
 	return new RegExp(`^${escapeRegex(str)}$`, flags);
@@ -207,6 +219,18 @@ function exactRegex(str, flags) {
 *
 * @param str the string to match.
 * @param flags flags for the RegExp.
+*
+* @example
+* ```ts
+* import { prefixRegex } from '@rolldown/pluginutils';
+* const plugin = {
+*   name: 'plugin',
+*   resolveId: {
+*     filter: { id: prefixRegex('foo') },
+*     handler(id) {} // will only be called for IDs starting with `foo`
+*   }
+* }
+* ```
 */
 function prefixRegex(str, flags) {
 	return new RegExp(`^${escapeRegex(str)}`, flags);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rolldown/pluginutils",
-  "version": "1.0.0-beta.14-commit.12b8061",
+  "version": "1.0.0-beta.16",
   "license": "MIT",
   "type": "module",
   "repository": {