Socket
Socket
Sign inDemoInstall

firestore-parser

Package Overview
Dependencies
0
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

firestore-parser

Parse the Firestore REST API endpoint JSON into a useable JS object


Version published
Maintainers
1
Weekly downloads
1,302
decreased by-20.12%

Weekly downloads

Readme

Source

firestore-parser · Maintainability Test Coverage npm version npm license

Parse the Firestore REST API JSON into a useable JS object

Installation

  // Install with NPM
  npm install firestore-parser --save
  // or Install with Yarn
  yarn add firestore-parser

Examples

Live Example

  // Node/AMD: 
  // const FireStoreParser = require('firestore-parser');
  // Node with TypeScript:
  // import * as FireStoreParser from 'firestore-parser';
  import FireStoreParser from 'firestore-parser'
  const projectID = 'PROJECT_ID'
  const key = 'API_KEY'
  const doc = 'DOCUMENT'
  const url = `https://firestore.googleapis.com/v1beta1/projects/${projectID}/databases/(default)/documents/${doc}?key=${key}`
  
  fetch(url)
    .then(response => response.json())
    .then(json => FireStoreParser(json))
    .then(json => console.log(json));

Data Structure

The Firestore JSON returned in the REST API, uses value type as keys. This can be difficult to work with since you have to know the data type prior getting the value. The firestore-parser removes this barrier for you.

JSON response from Firestore
{
	"player": {
		"mapValue": {
			"fields": {
				"name": {
					"stringValue": "steve"
				},
				"health": {
					"integerValue": "100"
				},
				"alive": {
					"booleanValue": true
				}
			}
		}
	},
	"level": {
		"integerValue": "7"
	}
}
JSON parsed with firestore-parser
{
	"player": {
		"name": "steve",
		"health": 100,
		"alive": true
	},
	"level": 7
}

Keywords

FAQs

Last updated on 29 Dec 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc