https://github.com/tejashah88/json-from-text

An algorithm for separating embedded JSON from a string, nicely packaged into a node.js module.
https://github.com/tejashah88/json-from-text

algorithm json json-parsing json-string nodejs parsing

Last synced: about 1 month ago
JSON representation

An algorithm for separating embedded JSON from a string, nicely packaged into a node.js module.

• Host: GitHub
• URL: https://github.com/tejashah88/json-from-text
• Owner: tejashah88
• License: mit
• Created: 2017-10-17T01:32:02.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-19T23:23:25.000Z (almost 6 years ago)
• Last Synced: 2024-10-10T09:05:53.432Z (about 1 month ago)
• Topics: algorithm, json, json-parsing, json-string, nodejs, parsing
• Language: JavaScript
• Homepage:
• Size: 62.5 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# json-from-text

[![NPM Version](https://img.shields.io/npm/v/json-from-text.svg)](https://www.npmjs.com/package/json-from-text)

[![Build Status](https://travis-ci.org/tejashah88/json-from-text.svg?branch=master)](https://travis-ci.org/tejashah88/json-from-text)

[![Coverage Status](https://coveralls.io/repos/github/tejashah88/json-from-text/badge.svg)](https://coveralls.io/github/tejashah88/json-from-text)

[![dependencies Status](https://david-dm.org/tejashah88/json-from-text/status.svg)](https://david-dm.org/tejashah88/json-from-text)

An algorithm for separating embedded JSON from a string, nicely packaged into an NPM module. It will attempt to parse potential JSON strings into objects and leave them as-is if it fails.

## Upgrading from < 1.0

If you are upgrading from < 1.0, please see [UPGRADING](UPGRADING.md) for migration instructions.

## Usage

```javascript

Object jsonFromText(String mixedStr, Boolean parseToObject)

```

### Parameters:

* `mixedStr`: The string to separate the JSON from the text.

* `parseToObject`: If set to `false`, the resulting JSON strings will not be translated to JSON objects. Default is `true`.

## Example

### Input

```javascript

var jsonFromText = require('json-from-text');

var sampleText = "There was a change from {'animal':'dog', 'color':'blue'} to {'animal':'cat', 'color':'red'}'";

var results = jsonFromText(sampleText);

console.log(JSON.stringify(results, null, 2));

```

### Output:

```json

{

  "textResults": [

    "There was a change from '",

    "' to '",

    "'"

  ],

  "jsonResults": [

    {

      "animal": "dog",

      "color": "blue"

    },

    {

      "animal": "cat",

      "color": "red"

    }

  ],

  "fullResults": [

    {

      "type": "text",

      "value": "There was a change from '"

    },

    {

      "type": "json",

      "parsed": true,

      "value": {

        "animal": "dog",

        "color": "blue"

      }

    },

    {

      "type": "text",

      "value": "' to '"

    },

    {

      "type": "json",

      "parsed": true,

      "value": {

        "animal": "cat",

        "color": "red"

      }

    },

    {

      "type": "text",

      "value": "'"

    }

  ]

}

```

## Mentions

* [rjrodger](https://github.com/rjrodger) for his [jsonic](https://github.com/rjrodger/jsonic) module, which does lenient JSON parsing

## License

Copyright (c) 2017-2018 Tejas Shah

MIT License, see [LICENSE](LICENSE.md) for details.