@mimik/user-filters

user-filters

Example

import { userDefinitions, validateDetail } from '@mimik/user-filters';
// or
import userFilters from '@mimik/user-filters';

• user-filters
  • static
    • .userDefinitions : Object.<string, UserDefinition>
    • sync
      • .validateDetail ⇒ string
  • inner
    • ~UserDefinition : object

user-filters.userDefinitions : Object.<string, UserDefinition>

Predefined user filter definitions keyed by detail level.

Kind: static constant of user-filters
Properties

Name	Type	Description
all	UserDefinition	All user attributes and properties including name and location.
basic	UserDefinition	Basic user attributes and properties.
references	UserDefinition	Basic user attributes and properties plus references.

user-filters.validateDetail ⇒ string

Validate the user detail.

Kind: static constant of user-filters
Returns: string - The selected detail.
Category: sync
Throws:

• Will throw an error if definitions is not an object or the detail is invalid.

Param	Type	Description
definitions	Object.<string, UserDefinition>	Predefined user filter definitions keyed by detail level.
detail	string	Detail selected for the user (e.g. 'all', 'basic', 'references').

user-filters~UserDefinition : object

Configuration for the user filter.

Kind: inner typedef of user-filters
Properties

Name	Type	Description
attributes	Array.<string>	User attributes to include (e.g. 'nickname', 'firstname', 'lastname').
properties	Array.<string>	User properties to include (e.g. 'nickName', 'displayName', 'email').