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

dynapromise-full-query

v0.0.2

Published

A full DynamoDB query in a promise.

Downloads

3

Readme

dynapromise-full-query

A full query of a DynamoDB table in a promise; it fetches all items matching the query, not just the first batch returned by AWS.

Install

npm install dynapromise-full-query

or

yarn add dynapromise-full-query

Usage

Async/await syntax

import fullQuery from 'dynapromise-full-query'
const countAllItems = async () => {
  try {
    const items = await fullQuery(
      { ... }, // Options used in 'new AWS.DynamoDB(options = {})' (see notes),
      { ... }, // Options used in 'dynamodb.query(options = {})' (see notes),
      {
        // Whether or not to surpress returning the results
        noReturn: false,

        // Function to process chunks of items as they are returned from AWS
        onChunk: () => {},

        // Number of times to reattempt retryable errors. Default 50.
        errorRetries: 50,
      }
    )
    console.log(`Query returned ${items.length} item/s`)
  }
  catch (err) {
    console.error(err)
  }
}

Promise syntax

const fullQuery = require('dynapromise-full-query');
const countAllItems = fullQuery(
  { ... }, // Options used in 'new AWS.DynamoDB(options = {})' (see notes),
  { ... }, // Options used in 'dynamodb.query(options = {})' (see notes),
  {
    // Whether or not to surpress returning the results
    noReturn: false,

    // Function to process chunks of items as they are returned from AWS
    onChunk: () => {},

    // Number of times to reattempt retryable errors. Default 50.
    errorRetries: 50,
  }
)
.then(items => console.log(`Query returned ${items.length} item/s`))
.catch(err => console.error(err))

Error handling

Errors are not caught by fullQuery as how they are handled is application specific. Therefore, please use try...catch syntax when using async syntax or the .catch method when using Promise syntax.

API

fullQuery(dbOptions, queryParams, [fullQueryParams])

Performs a dynamodb query using the given db connection information and query options.

  • dbOptions - an object passed to the AWS.DynamoDB constructor (see notes)
  • queryParams - an object passed to the AWS.DynamoDB.query method (see notes)
  • fullQueryParams - an object with options for the fullQuery call
    • noReturn - a boolean value indicating if results should be returned or not.
    • onChunk - a function which is processed for each chunk of items returned. Receives the same data object defined in the AWS.DynamoDB.query callback method (see notes).
    • errorRetries - a int value stating the number of times to retry retriable errors before throwing the error. Default 50.

AWS References

  1. AWS.DynamoDB constructor options (first fullQuery parameter)
  2. AWS.DynamoDB.query options (second fullQuery parameter)