getByValue<T>( match: string | RegExp, options?: { all?: false; raw?: false },): undefined | T Parameters
- match: string | RegExp
Optional
options: { all?: false; raw?: false }
Returns undefined | T
getByValue<T>(match: string | RegExp, options: { all: true; raw?: false }): T[] Parameters
- match: string | RegExp
- options: { all: true; raw?: false }
Returns T[]
getByValue<T>( match: string | RegExp, options: { all?: false; raw: true },): undefined | RawModule<T> Parameters
- match: string | RegExp
- options: { all?: false; raw: true }
Returns undefined | RawModule<T>
getByValue<T>( match: string | RegExp, options: { all: true; raw: true },): RawModule<T>[] Parameters
- match: string | RegExp
- options: { all: true; raw: true }
getByValue<T>( match: string | RegExp, options: { all: boolean; raw?: false },): undefined | T | T[] Parameters
- match: string | RegExp
- options: { all: boolean; raw?: false }
Returns undefined | T | T[]
getByValue<T>( match: string | RegExp, options: { all: boolean; raw: true },): RawModule<T> | RawModule<T>[] Parameters
- match: string | RegExp
- options: { all: boolean; raw: true }
getByValue<T>( match: string | RegExp, options: { all?: false; raw: boolean },): undefined | T | RawModule<T> Parameters
- match: string | RegExp
- options: { all?: false; raw: boolean }
Returns undefined | T | RawModule<T>
getByValue<T>( match: string | RegExp, options: { all: true; raw: boolean },): T[] | RawModule<T>[] Parameters
- match: string | RegExp
- options: { all: true; raw: boolean }
getByValue<T>( match: string | RegExp, options?: { all?: boolean; raw?: boolean },): undefined | T | T[] | RawModule<T> | RawModule<T>[] Parameters
- match: string | RegExp
Optional
options: { all?: boolean; raw?: boolean }
Retrieves a module by matching its exported values against a string or regular expression.
Equivalent to
getModule(filters.byValue(match), options)
.Template: T
The type of the module to be returned.
Param: match
A string or regular expression to match the module's value.
Param: options
Configuration options for the module retrieval.
Returns
The matching module(s) or raw module(s), or
undefined
if no match is found.See