# uber-json-schema-filter

> Filters (removes) objects from document based on passed json-schema

Latest version **2.0.5** (published 2017-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install uber-json-schema-filter
pnpm add uber-json-schema-filter
yarn add uber-json-schema-filter
bun add uber-json-schema-filter
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.5 |
| Published | 2017-06-15 |
| First published | 2015-01-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Author | Andrew Lank |
| Maintainers | uber |
| Keywords | json-schema, node.js, npm, module |

## Links

- npm: https://www.npmjs.com/package/uber-json-schema-filter
- Repository: https://github.com/uber/json-schema-filter
- Homepage: https://github.com/uber/json-schema-filter#readme
- Issues: https://github.com/uber/json-schema-filter/issues
- npm.io page: https://npm.io/package/uber-json-schema-filter

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 2.0.5 (latest) — 2017-06-15
- 2.0.4 — 2017-06-15
- 2.0.3 — 2017-03-04
- 2.0.2 — 2015-01-28
- 2.0.1 — 2015-01-16
- 1.0.0 — 2015-01-16

## README

#json-schema-filter

Filters (removes) objects recursively from document based on passed json-schema

**Note that this does NOT validate your document against the schema, use something like ```JSV``` npm after calling.**

For performance reasons it is assumed that the json-schema contains less items then the document, that is you are going to be removing from the document in most or all cases, if not I would recommend another solution which bases its recursive evaluation on the document instead.

### Install

```bash
$ npm install uber-json-schema-filter
```

### Usage...

```javascript

var filter = require('uber-json-schema-filter');

var schema = {
    "title": "Example Schema",
    "type": "object",
    "properties": {
      "firstName": {
        "type": "string"
      },
      "lastName": {
        "type": "string"
      },
      "age": {
        "description": "Age in years",
        "type": "integer",
        "minimum": 0
      },
      "general": {
        "type": "object",
        "required": false
      },
      "contacts": {
        "type": "array",
        "id": "http://jsonschema.net/contacts",
        "required": false,
        "items": {
          "type": "object",
          "id": "http://jsonschema.net/contacts/0",
          "required": false,
          "properties": {
            "phone": {
              "type": "string",
              "required": false
            }
          }
        }
      },
      "hobbies":{
        "type": "array",
        "required": false,
        "items": {
          "type": "string"
        }
      }
    },
    "required": ["firstName", "lastName"]
};

var document = {firstName: 'John', lastName: 'Dow!', shouldNot: 'see this!'};

var results = filter(schema, document);   

console.log(results);  // # {firstName: 'John', lastName: 'Dow!'}

// Works on nested objects and arrays as well...
var document2 = {
    firstName: 'Johnny',
    lastName: 'Dowsky',
    contacts: [
        {phone: '303943', shouldNot: 'see this!'},
        {phone: '399494'}
    ]
}
var nestedResults = filter(schema, document2);

console.log(nestedResults);  // # {firstName: 'Johnny', lastName: 'Dowski', contacts: [{phone: '303943', phone: '399494'}]}


```

### Notes:

#### "object" without "properties" or free form objects

If a ```"type": "object"``` with no ```"property":``` is defined (see 'general:' in above example), or empty, the entire object is removed from the results. It could be that you require it to be included but empty, but to the best of my knowledge I thought it would be cleaner to simply remove it if empty. Else it copies everything over, as in all of what is in the properties of the key.

Background info: The lack of ```property``` is legal in json-schema and means anything goes, or what I refer to as free-form.. free-style.. oh well, pick your meaning for it, it has the word 'free'!

---
_Source: https://npm.io/package/uber-json-schema-filter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._