npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

firestore-wrapper

v0.1.8

Published

Typing your firestore database and avoid access errors on development

Downloads

113

Readme

Purpose

typescript helps to avoid numerous errors at development time and for sure firebase is one of the most used tools among developers, be it for mobile, web projects and etc.

The biggest problem is that we have to force data types when we access them through the firebase and this can cause numerous errors.

The firestore-wrapper has the purpose of facilitating and speeding up the life of the developer, being necessary to type your database only once.

How to use

1) Describe your database

In some file, describe your database using a typescript, look like this:

export interface Database {
    User: {[user_id: string]: User};
    Locations: {[location_name: string]: Locations};
}

interface User {
    name: string,
    email: string,
    nick: string
}

interface Locations {
    latitude: number;
    longitude: number;
    single: string;
}

2) Initialize your firebase-admin and associate with wapper

import * as firebase from "firebase-admin";
import Credentials from "../Credentials.json";
import { root } from "firestore-wrapper";
import databaseSchema from './database';

const firebaseSdk = firebase.initializeApp({
    credential: firebase.credential.cert(Credentials as firebase.ServiceAccount),
    databaseURL: "https://any-project.firebaseio.com"  
});

const db = root<databaseSchema>(firebaseSdk.firestore() as any);

3) Now, all firestore functions is typing with your database schema

While you access your database, the wrapper indicates if the path is right

Specs

When you retrieve data, he cames with right type

Specs

Even inside transactions, you keep the types

Specs