# parse-neo4j

> Parse results from neo4j's http endpoint to normal JSON

Latest version **0.6.11** (published 2018-01-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install parse-neo4j
pnpm add parse-neo4j
yarn add parse-neo4j
bun add parse-neo4j
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.11 |
| Published | 2018-01-04 |
| First published | 2016-09-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Keyvan Mir Mohammad Sadeghi |
| Maintainers | assister |
| Keywords | endpoint, http, parser, neo4j |

## Links

- npm: https://www.npmjs.com/package/parse-neo4j
- Repository: https://github.com/assister-ai/parse-neo4j
- Homepage: https://github.com/assister-ai/parse-neo4j#readme
- Issues: https://github.com/assister-ai/parse-neo4j/issues
- npm.io page: https://npm.io/package/parse-neo4j

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.6.11 (latest) — 2018-01-04
- 0.6.10 — 2017-08-05
- 0.6.9 — 2017-08-03
- 0.6.8 — 2016-12-27
- 0.6.7 — 2016-12-25
- 0.6.6 — 2016-12-24
- 0.6.5 — 2016-12-24
- 0.6.4 — 2016-12-14
- 0.6.3 — 2016-11-06
- 0.6.2 — 2016-09-17
- 0.6.1 — 2016-09-17
- 0.6.0 — 2016-09-17
- 0.5.7 — 2016-09-17
- 0.5.6 — 2016-09-12
- 0.5.5 — 2016-09-07
- … 5 more at https://npm.io/package/parse-neo4j/versions

## README

[![npm version](https://badge.fury.io/js/parse-neo4j.svg)](https://www.npmjs.com/package/parse-neo4j)

# parse-neo4j

Neo4j's http endpoint produces result that contains complete query information.

`parse-neo4j` helps those who only want what they've returned in the query as normal JSON.

## Install

```bash
npm install parse-neo4j --save
```

## Usage
You can connect to neo4j's http endpoint via one of the many drivers available, e.g. official [`neo4j-driver`](https://github.com/neo4j/neo4j-javascript-driver)
```javascript
var neo4j = require('neo4j-driver').v1;
var driver = neo4j.driver("bolt://localhost", neo4j.auth.basic("neo4j", "neo4j"));
var session = driver.session();
var result = session
    .run("MERGE (james:Person {name : {nameParam} }) RETURN james.name", { nameParam:'James' })
    .catch(function(error) {
        console.log(error);
    });
```
Then you can parse the results:
```javascript
var parser = require('parse-neo4j');
var parsedResult = result
    .then(parser.parse)
    .then(function(parsed){
        parsed.forEach(function(parsedRecord) {
            console.log(parsedRecord);
        });
    })
    .catch(function(parseError) {
        console.log(parseError);
    });
```
`parser.parseRecord` could also be used for parsing a single record.

## Example

Assuming below query:
```cypher
MATCH (a:Label1)
MATCH (a)-[:Another]->(b)
RETURN a AS key1, b AS key2
ORDER BY a.date DESC
LIMIT 2
```

You get this output:
```JSON
[
    {
        "key1": {
            "field1": "...",
            "number": 42,
            "date": 1460183280000
        },
        "key2": {}
    },
    {
        "key1": {
            "field1": "...",
            "number": 2,
            "date": 1460183280000
        },
        "key2": {}
    },
]
```

As opposed to:
```JSON
{
   "records":[
      {
         "keys":[
            "key1",
            "key2"
         ],
         "length":2,
         "_fields":[
            {
               "identity":{
                  "low":143258,
                  "high":0
               },
               "labels":[
                  "Label1",
                  "Label2"
               ],
               "properties":{
                  "field1":"...",
                  "number":{
                     "low":42,
                     "high":0
                  },
                  "date":1460183280000
               }
            },
            {
               "identity":{
                  "low":117186,
                  "high":0
               },
               "labels":[
                  "Another",
                  "Node"
               ],
               "properties":{}
            }
         ],
         "_fieldLookup":{
            "key1":0,
            "key2":1
         }
      },
      {
         "keys":[
            "key1",
            "key2"
         ],
         "length":2,
         "_fields":[
            {
               "identity":{
                  "low":143260,
                  "high":0
               },
               "labels":[
                  "Label1",
                  "Label2"
               ],
               "properties":{
                  "field1":"...",
                  "number":{
                     "low":2,
                     "high":0
                  },
                  "date":1460183280000
               }
            },
            {
               "identity":{
                  "low":117186,
                  "high":0
               },
               "labels":[
                  "Another",
                  "Node"
               ],
               "properties":{}
            }
         ],
         "_fieldLookup":{
            "key1":0,
            "key2":1
         }
      }
   ],
   "summary":{
      "statement":{
         "text":"MATCH (a:Label1)\nMATCH (a)-[:Another]->(b)\nRETURN a AS key1, b AS key2\nORDER BY a.date DESC\nLIMIT 2",
         "parameters":{
            "skip":{
               "low":10,
               "high":0
            },
            "limit":{
               "low":2,
               "high":0
            }
         }
      },
      "statementType":"r",
      "updateStatistics":{
         "_stats":{
            "nodesCreated":0,
            "nodesDeleted":0,
            "relationshipsCreated":0,
            "relationshipsDeleted":0,
            "propertiesSet":0,
            "labelsAdded":0,
            "labelsRemoved":0,
            "indexesAdded":0,
            "indexesRemoved":0,
            "constraintsAdded":0,
            "constraintsRemoved":0
         }
      },
      "plan":false,
      "profile":false,
      "notifications":[

      ]
   }
}
```

## License
[MIT](https://github.com/assister-ai/parse-neo4j/blob/master/LICENSE)

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