angular2-firebase

KO | EN

gitlite — search

#javascript #python #typescript #nodejs #windows #react #reactjs #css #minecraft #android #docker #python3

angular2-firebase

★ 34 Open GitHub ↗

Early Angular 2 / Firebase adapter. Now obsolete, since the official angularfire2 is ready for prime time.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DEPRECATED - Angular 2 Firebase Tools

## Use this instead:

There is an official Angular 2 <-> Firebase library now (as of 2017) in find
condition for real use, implemented by the team at Firebase / Google:

https://angularfire2.com/

https://github.com/angular/angularfire2

You should probably use that library. It certainly has more documentation
and features than this one.

# Old, Third Party A2-Firebase Library

This third-party library existed because:

* I started well before the official library.
* I was able to get applications up and running with it.
* It has a considerably more minimal approach, contrasting the
  "wrap outside things in Angular thing"
  approach used by angularfire2.

## Introduction

An application should be able to consume data *without* caring
about the on() Firebase API, Firebase events, or the
object-as-pseudo-array convention.

The library currently includes:

* Firebase Observable object, a very straightforward implementation.
* Firebase Observable array, which understands the pattern of events emitted
  by Firebase and produces an observable of the resulting array.

Many areas are still under consideration and development:

* Writing to Firebase.
* Following references (joins)
* A way to generate TS schema from Bolt schema, or vice versa.

## Demo

https://github.com/OasisDigital/angular2-firebase-demo

## Why Observables? Why the async pipe?

By wrapping the Firebase API behind Observables,
then consuming those Observables typically via an async pipe,
it should never be necessary to manually subscribe
and unsubscribe the Observables,
nor manually hook and unhook Firebase events.

I believe that, if you find it necessary to write ngOnDestroy in a visual component,
it is a sign that the component is not yet sufficienty abstracted.

## How to Consume

It will generally "just work" with typescript and webpack.
Other combinations might work, but still need attention.

As far as I can tell, TypeScript with NPM modules is still a topic of much
discussion and work. This library does the following,
it appears to be the preferred approach:

* Leave the TypeScript code in the repository, don't ship it in the NPM package
* Ship ES5 code with .d.ts
* Also ship ES6 code with .d.ts, to enable downstream "tree shaking".

Older versions of this library included typings for Firebase;
the "typings" and related tooling have made that obsolete.
Use typings or other means to obtain the Firebase .d.ts file,
and include it in your project.

For examples of working tsconfig and typings, see the demo:

https://github.com/OasisDigital/angular2-firebase-demo

Kyle Cordes
http://kylecordes.com

angular2-firebase

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README