# @monkey-space/loopback-component-filter

> loopback component to filter deep with relations

Latest version **0.0.5** (published 2021-08-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install @monkey-space/loopback-component-filter
pnpm add @monkey-space/loopback-component-filter
yarn add @monkey-space/loopback-component-filter
bun add @monkey-space/loopback-component-filter
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2021-08-23 |
| First published | 2021-08-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10.16 |
| Dependencies | 3 |
| Unpacked size | 34.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | alanfernando93 |
| Maintainers | alanfernando93 |
| Keywords | loopback-extension, loopback-query-data, loopback-filter, loopback-relation-filter, loopback |

## Links

- npm: https://www.npmjs.com/package/@monkey-space/loopback-component-filter
- Repository: https://gitlab.com/monkey-space/loopback-component-filter
- Homepage: https://gitlab.com/monkey-space/loopback-component-filter#readme
- Issues: https://gitlab.com/monkey-space/loopback-component-filter/issues
- npm.io page: https://npm.io/package/@monkey-space/loopback-component-filter

## Dependencies (3)

- [tslib](https://npm.io/package/tslib.md) ^2.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@loopback/repository](https://npm.io/package/@loopback/repository.md) ^3.7.1

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2021-08-23
- 0.0.4 — 2021-08-23
- 0.0.3 — 2021-08-22
- 0.0.2 — 2021-08-22
- 0.0.1 — 2021-08-21

## README

# loopback-component-filter

[![LoopBack](https://github.com/strongloop/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)-@2x.png)](http://loopback.io/)

## Installation

Install LoopbackFilterComponent using `npm`;

```sh
$ npm install @monkey-space/loopback-component-filter
```

## Basic Use

Configure and load LoopbackFilterComponent in the application constructor
as shown below.

```ts
import {DeepCrudRepository} from '@monkey-space/loopback-component-filter';
```

replace <code>DefaultCrudRepository</code> to <code>DeepCrudRepository</code> in folder repositories

```ts
export class TrackingRoomRepository extends DeepCrudRepository<
  TrackingRoom,
  typeof TrackingRoom.prototype.id,
  TrackingRoomRelations
> {
  // Only the Find property is affected by the base repository DeepCrudRepository
...
```

## Format filter
body example to filter format

```json
{
  "where": {
      "payments": "undefined", // Returns all entities if `payments` is different to undefined (it is required)
      "payments.name": "example",
      "payments.description": "valueToEqual",
  },
  "include": ["payments"],
  // Order, Fields, Limit remains the configuration
}
```

more examples, folder ***/src/__tests__/integration***

---
_Source: https://npm.io/package/@monkey-space/loopback-component-filter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
