https://github.com/invertase/firebase-relationship

A simple Firebase Realtime Database relationship manager.
https://github.com/invertase/firebase-relationship

firebase firebase-relationship npm

Last synced: about 2 months ago
JSON representation

A simple Firebase Realtime Database relationship manager.

• Host: GitHub
• URL: https://github.com/invertase/firebase-relationship
• Owner: invertase
• Created: 2017-01-03T14:24:04.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-08T17:21:25.000Z (over 7 years ago)
• Last Synced: 2024-11-16T03:18:16.722Z (2 months ago)
• Topics: firebase, firebase-relationship, npm
• Language: JavaScript
• Homepage: https://invertase.io
• Size: 3.91 KB
• Stars: 5
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Firebase Relationship

[![NPM version][npm-image]][npm-url]

[![Donate](https://img.shields.io/badge/Donate-Patreon-green.svg)](https://www.patreon.com/invertase)

A promise based helper to manage relationships in your Firebase Realtime Database.

## Usage

```bash

npm install firebase-relationship --save

```

```javascript

import Firebase from 'firebase';

import Relationship from 'firebase-relationship';

// Create a new Firebase & Relationship instance

const firebase = Firebase.initializeApp({...});

const relationship = new Relationship('category_product');

// Create a new relationship between a category (id: 123) and a product (id: abc)

relationship.join(firebase, 123, 'abc');

// Remove the relationship

relationship.remove(firebase, 123, 'abc');

```

## API

### - constructor(name, path)

Creates and returns a new relationship.

- **[name]** Relationship name. Must include only one underscore.

- **[path]** Firebase path to store relationships. Defaults to 'relationship'. Must not contain leading or trailing forward slashes.

### - join(instance, leftId, rightId, value?) : Promise

Creates a two way relationship between two IDs. The 4th param is an optional value to store with the relationship (defaults to true).

### - remove(instance, leftId, rightId) : Promise

Removes a two way relationship between two IDs.

## Magic Methods

When a new relationship instance is created, four magic methods are available for easy relationship querying. For example, with a "category_product" relationship:

```javascript

// Get products for a category

relationship.getCategoryProducts(firebase, categoryId).then((snapshot) => {

  console.log('Products', snapshot.val());

});

// Get product categories

relationship.getProductCategories(firebase, productId).then((snapshot) => {

  console.log('Categories', snapshot.val());

});

// you can also get the internal refs for a join

const refA = relationship.getCategoryProductsRef;

const refB = relationship.getProductCategoriesRef;

// ... do a custom query ?

```

> Each relationship name is pluralized.

[npm-image]: https://img.shields.io/npm/v/firebase-relationship.svg?style=flat-square

[npm-url]: https://npmjs.org/package/firebase-relationship