npm.io
1.1.1 • Published 4 years ago

easy-firestore

Licence
MIT
Version
1.1.1
Deps
0
Size
6 kB
Vulns
0
Weekly
0
Stars
4
SummaryDependencyVersions

easy-firestore

This package will help you in getting data and managing images with firebase.

Installation

npm i easy-firestore

or 

yarn add easy-firestore

API Reference

Get all documents in a collection
import {useDocs} from "easy-firestore/hooks"

const {data, numberOfData, dataLoading} = useDocs(db, collectionName)
Parameter Type Description
db Required. Your firestore database
collectionName string Required. Your collection name
data array All data in the collection
numberOfData number Number of items in your collection
dataLoading boolean Tells you if the process of getting data is done or not
Example
const {data: products, numberOfData: numberOfProducts, dataLoading: productsLoading} = useDocs(db, "products")

products.forEach(product => (
  console.log(product.id)
))
Get all documents that matched to a condition in a collection
import {useWhereDocs} from "easy-firestore/hooks"

const {data, numberOfData, dataLoading} = useWhereDocs(db, collectionName, whereToLookInTheDocument, whereToLookValue)
Parameter Type Description
db Required. Your firestore database
collectionName string Required. Your collection name
whereToLookInTheDocument string Required. The field of the document that has to match to the condition
whereToLookValue number or string Required. The value we will use to check if it matched with the document field
data array All data in the collection
numberOfData number Number of items in your collection
dataLoading boolean Tells you if the process of getting data is done or not 
const {data: users, numberOfData: numberOfUsers, dataLoading: usersLoading} = useWhereDocs(db, "users", "city", "senegal")

users.forEach(user => (
  console.log(user.firstname)
))
Get the url image
import {useImgUrl} from "easy-firestore/hooks"

const {imgUrl, setImgUrl, percentage} = useImgUrl(storage, file)
Parameter Type Description
storage Required. Your firestore storage
file object Required. The selected file from your pictures
imgUrl string The url of your selected image that you can store on firestore then use it any where
percentage number You can use this number to create a progressive bar

Keywords

[firebasefirestoredatadocumentsnoSql]