foundation-filters.usertargetingfilter
Home > @genesislcap/foundation-filters > userTargetingFilter
userTargetingFilter() function
UserTargeting client filter function.
Signature:
export declare function userTargetingFilter(user: User, usernames?: string[], profiles?: string[], permissions?: string[]): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| user | User | A user object. |
| usernames | string[] | (Optional) Usernames to target. |
| profiles | string[] | (Optional) Profiles to target. |
| permissions | string[] | (Optional) Permissions to target. |
Returns:
boolean
Remarks
This will return true when the current user matches on ANY of the parameters. If you wish to match on multiple parameters, consider chaining an array of userTargeting filters together.