firecrud-react
v1.0.2
Published
React api library for firestore
Downloads
2
Readme
Table of contents
- What is Firecrud?
- Getting Started
- CREATE
- READ
- UPDATE
- DELETE
To get started with firecrud-react
, run the following command:
npm
npm i firecrud-react
Initialize Firecrud
imports
import { useFirestore } from 'firebase-react'
import db from '../firebase'
initialize your db
const { fireStore } = useFirestore(db)
To create or overwrite a single document, use the fireStore.get()
method:
const { fireStore } = useFirestore(db)
const data = fireStore.get({
name: "Los Angeles",
state: "CA",
country: "USA"
}, "cities", "LA")
If the document does not exist, it will be created. If the document does exist, its contents will be overwritten with the newly provided data, unless you use the fireStore.post
method, as follows:
const data = firestore.post( null, 'cities', 'BJ' )
For a better alternative, check out Update doc
Example data
To get started, write some data about cities so we can look at different ways to read it back:
const data = fireStore.post({
name: "Los Angeles",
state: "CA",
country: "USA"
}, "cities", "LA")
console.log(data)
const data = fireStore.get("cities", "LA")
console.log(data)
//output:
//{
// name: "Los Angeles",
// state: "CA",
// country: "USA"
//}
To update some fields of a document without overwriting the entire document, use the fireStore.update
method:
const data = fireStore.update({
state: "California",
country: "United States"
}, "cities", "LA")
To delete a document, use the fireStore.delete
method:
const data = fireStore.delete("cities", "LA")