getByProps<T, P extends PropertyKey = keyof T>( props: P[], options?: { all?: false; raw?: false },): T | undefined Type Parameters
- T
- P extends PropertyKey = keyof T
Parameters
- props: P[]
Optionaloptions: { all?: false; raw?: false }
Returns T | undefined
getByProps<T, P extends PropertyKey = keyof T>( props: P[], options: { all: true; raw?: false },): T[] Type Parameters
- T
- P extends PropertyKey = keyof T
Parameters
- props: P[]
- options: { all: true; raw?: false }
Returns T[]
getByProps<T, P extends PropertyKey = keyof T>( props: P[], options: { all?: false; raw: true },): RawModule<T> | undefined Type Parameters
- T
- P extends PropertyKey = keyof T
Parameters
- props: P[]
- options: { all?: false; raw: true }
Returns RawModule<T> | undefined
getByProps<T, P extends PropertyKey = keyof T>( props: P[], options: { all: true; raw: true },): RawModule<T>[] Type Parameters
- T
- P extends PropertyKey = keyof T
Parameters
- props: P[]
- options: { all: true; raw: true }
getByProps<T, P extends PropertyKey = keyof T>( props: P[], options?: { all: true; raw?: boolean },): T[] | RawModule<T>[] Type Parameters
- T
- P extends PropertyKey = keyof T
Parameters
- props: P[]
Optionaloptions: { all: true; raw?: boolean }
getByProps<T, P extends PropertyKey = keyof T>( props: P[], options: { all?: false; raw?: boolean },): T | RawModule<T> | undefined Type Parameters
- T
- P extends PropertyKey = keyof T
Parameters
- props: P[]
- options: { all?: false; raw?: boolean }
Returns T | RawModule<T> | undefined
getByProps<T, P extends PropertyKey = keyof T>( props: P[], options: { all?: boolean; raw: true },): RawModule<T> | RawModule<T>[] | undefined Type Parameters
- T
- P extends PropertyKey = keyof T
Parameters
- props: P[]
- options: { all?: boolean; raw: true }
getByProps<T, P extends PropertyKey = keyof T>( props: P[], options: { all?: boolean; raw?: false },): T | T[] | undefined Type Parameters
- T
- P extends PropertyKey = keyof T
Parameters
- props: P[]
- options: { all?: boolean; raw?: false }
Returns T | T[] | undefined
getByProps<T, P extends PropertyKey = keyof T>( props: P[], options?: { all?: boolean; raw?: boolean },): T | T[] | RawModule<T> | RawModule<T>[] | undefined Type Parameters
- T
- P extends PropertyKey = keyof T
Parameters
- props: P[]
Optionaloptions: { all?: boolean; raw?: boolean }
getByProps<T, P extends PropertyKey[] = (
keyof T)
[]>(...props: P): T | undefined Type Parameters
- T
- P extends PropertyKey[] = (keyof T)[]
Returns T | undefined
Retrieves a module(s) by their properties.
Equivalent to
getModule(filters.byProps(...props), options).Template: T
The type of the module(s) being retrieved.
Template: P
The type of the property keys being searched for.
Param: args
Either an array of property keys to search for, or an array containing the property keys and an optional configuration object.
Returns
The module(s) or processed exports that match the specified properties, or
undefinedif no match is found.See