# @mimik/user-filters

> Filter definitions for users

Latest version **2.1.1** (published 2026-07-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @mimik/user-filters
pnpm add @mimik/user-filters
yarn add @mimik/user-filters
bun add @mimik/user-filters
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2026-07-07 |
| First published | 2018-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=24.0.0 |
| Dependencies | 0 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | mimik technology inc |
| Maintainers | mimik-npm-editor, hofachiang, miburger, mimikopensource, sasan.raisdana |
| Keywords | mimik, microservice |

## Links

- npm: https://www.npmjs.com/package/@mimik/user-filters
- Repository: https://bitbucket.org/mimiktech/user-filters
- Homepage: https://bitbucket.org/mimiktech/user-filters#readme
- Issues: https://bitbucket.org/mimiktech/user-filters/issues
- npm.io page: https://npm.io/package/@mimik/user-filters

## Recent versions

- 2.1.1 (latest) — 2026-07-07
- 2.1.0 — 2026-03-21
- 2.0.4 — 2025-07-17
- 2.0.3 — 2025-05-01
- 2.0.2 — 2025-04-27
- 2.0.1 — 2025-03-25
- 2.0.0 — 2025-03-03
- 1.3.7 — 2023-12-05
- 1.3.6 — 2022-12-27
- 1.3.5 — 2022-12-02
- 1.3.4 — 2022-05-11
- 1.3.3 — 2022-04-14
- 1.3.2 — 2021-12-16
- 1.2.0 — 2019-09-06
- 1.1.0 — 2019-09-06
- … 3 more at https://npm.io/package/@mimik/user-filters/versions

## README

<a name="module_user-filters"></a>

## user-filters
**Example**  
```js
import { userDefinitions, validateDetail } from '@mimik/user-filters';
// or
import userFilters from '@mimik/user-filters';
```

* [user-filters](#module_user-filters)
    * _static_
        * [.userDefinitions](#module_user-filters.userDefinitions) : <code>Object.&lt;string, UserDefinition&gt;</code>
        * _sync_
            * [.validateDetail](#module_user-filters.validateDetail) ⇒ <code>string</code>
    * _inner_
        * [~UserDefinition](#module_user-filters..UserDefinition) : <code>object</code>

<a name="module_user-filters.userDefinitions"></a>

### user-filters.userDefinitions : <code>Object.&lt;string, UserDefinition&gt;</code>
Predefined user filter definitions keyed by detail level.

**Kind**: static constant of [<code>user-filters</code>](#module_user-filters)  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| all | <code>UserDefinition</code> | All user attributes and properties including name and location. |
| basic | <code>UserDefinition</code> | Basic user attributes and properties. |
| references | <code>UserDefinition</code> | Basic user attributes and properties plus references. |

<a name="module_user-filters.validateDetail"></a>

### user-filters.validateDetail ⇒ <code>string</code>
Validate the user detail.

**Kind**: static constant of [<code>user-filters</code>](#module_user-filters)  
**Returns**: <code>string</code> - 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 | <code>Object.&lt;string, UserDefinition&gt;</code> | Predefined user filter definitions keyed by detail level. |
| detail | <code>string</code> | Detail selected for the user (e.g. 'all', 'basic', 'references'). |

<a name="module_user-filters..UserDefinition"></a>

### user-filters~UserDefinition : <code>object</code>
Configuration for the user filter.

**Kind**: inner typedef of [<code>user-filters</code>](#module_user-filters)  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| attributes | <code>Array.&lt;string&gt;</code> | User attributes to include (e.g. 'nickname', 'firstname', 'lastname'). |
| properties | <code>Array.&lt;string&gt;</code> | User properties to include (e.g. 'nickName', 'displayName', 'email'). |

---
_Source: https://npm.io/package/@mimik/user-filters · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._