Interface: HookFilter

Defined in: plugin/hook-filter.ts:27

A filter to be used to do a pre-test to determine whether the hook should be called.

See Plugin Hook Filters page for more details.

Properties

code?

• Type: GeneralHookFilter<string | RegExp>
• Optional

Defined in: plugin/hook-filter.ts:75

A filter based on the module's code.

Only available for transform hook.

---

id?

• Type: GeneralHookFilter<string | RegExp>
• Optional

Defined in: plugin/hook-filter.ts:63

A filter based on the module id.

If the value is a string, it is treated as a glob pattern. The string type is not available for resolveId hook.

Examples

Include all ids that contain node_modules in the path.

{ id: '**'+'/node_modules/**' }

Include all ids that contain node_modules or src in the path.

{ id: ['**'+'/node_modules/**', '**'+'/src/**'] }

Include all ids that start with http

{ id: /^http/ }

Exclude all ids that contain node_modules in the path.

{ id: { exclude: '**'+'/node_modules/**' } }

Formal pattern to define includes and excludes.

{ id : {
  include: ['**'+'/foo/**', /bar/],
  exclude: ['**'+'/baz/**', /qux/]
}}

---

moduleType?

• Type: ModuleTypeFilter
• Optional

Defined in: plugin/hook-filter.ts:69

A filter based on the module's moduleType.

Only available for transform hook.