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

firebase-database-pagination

v4.0.1

Published

Pagination for Firebase RTDB

Downloads

319

Readme

Firebase Database Pagination

Node.js CI

Allows pagination for the Firebase RTDB.

Usage

All the normal methods return an array of DataSnapshots.

Keys

To paginate over all the keys of a node you can use:

const pagination = require('firebase-database-pagination')
const admin = require('firebase-admin').initializeApp()

const children = await pagination.key(admin.database().ref('node'), 10)

This will fetch all children of node in batches of 10.

Value

To paginate over keys order by the nodes value you can use:

const pagination = require('firebase-database-pagination')
const admin = require('firebase-admin').initializeApp()

const children = await pagination.value(admin.database().ref('node'), 10)

Child

To paginate over all the keys of a node order by a childs key you can use:

const pagination = require('firebase-database-pagination')
const admin = require('firebase-admin').initializeApp()

const children = await pagination.child(admin.database().ref('node'), 'childKey', 10)

Transform parameter

The .key, .value and .child methods have a .transformed function property which allows each result to be converted to something else if needed.

The transformer parameter can return a value or a promised value.

const pagination = require('firebase-database-pagination')
const admin = require('firebase-admin').initializeApp()

const values = await pagination.key.transformed(admin.database().ref('node'), 10, nodeChildSnapshot => {
   return { key: nodeChildSnapshot.key, value: nodeChildSnapshot.child('count') }
})
// values is an array of { key, count }

const values = await pagination.key.transformed(admin.database().ref('node'), 10, async nodeChildSnapshot => {
   return await admin.database().ref('other').child(nodeChildSnapshot.key)
})
// values is an array of DataSnaphots pointing at /other/<nodeChildKey>

Limiting the query

All of the methods except a parameter to return a subset of values.

const pagination = require('firebase-database-pagination')
const admin = require('firebase-admin').initializeApp()

// Return all keys where the value is equal to 10
await pagination.value(admin.database().ref('node'), 10, { equalTo: 10 })

// Return all keys where the value is greater then or equal to 10
await pagination.value(admin.database().ref('node'), 10, { startAt: 10 })

// Return all keys where the value is less then or equal to 20
await pagination.value(admin.database().ref('node'), 10, { endAt: 20 })

// Return all keys where the value is greater then or equal to 15 AND less than or equal to 25 (i.e. in the interval [15, 25])
await pagination.value(admin.database().ref('node'), 10, { startAt: 15, endAt: 25 })