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

sqs-quooler

v1.9.1

Published

An abstraction of AWS SQS

Downloads

17,123

Readme

SQS Quooler

Build Status npm

:walking::walking::walking::walking: An abstraction of Amazon's SQS SDK. It provides an easier to use interface than that of Amazon's SDK.

Installation

npm install --save sqs-quooler

Usage

Connecting to the queue

Note aws-sdk still needs to be imported. SQS Quooler is just a wrapper.

const { SQS, Credentials } = require('aws-sdk')
const { Queue } = require('sqs-quooler')

const sqs = new SQS({
  region: 'your aws region',
  endpoint: 'your aws endpoint',
  // Credentials can be used with YOPA as below
  // credentials: new Credentials({
  //   accessKeyId: 'x',
  //   secretAccessKey: 'x',
  // }),
})

const myQueue = new Queue({
  sqs,
  endpoint: 'your aws endpoint + queue name',
  concurrency: 1, // MaxNumberOfMessages
})

Pushing items to the queue

myQueue.push (data: any) : Promise

Data sent via .push will be stringified before it's sent to SQS.

myQueue.push({
  data: 'test',
})

Removing items from the queue

myQueue.remove (message: object) : Promise

Message object should have a ReceiptHandle property, to identify the message.

myQueue.remove({
  ...
  ReceiptHandle: 'receipt handle',
  ...
})

Changing message visibility

myQueue.changeMessageVisibility (parameters: object) : Promise

Parameters object should have a ReceiptHandle property, to identify the message, and a VisibilityTimeout property to determine in how many seconds the item will return to the queue.

myQueue.changeMessageVisibility({
  ...
  ReceiptHandle: 'receipt handle',
  VisibilityTimeout: 0, // returns immediately to the queue
  ...
})

Retrieving items from the queue

myQueue.startProcessing (handler: function, options: object) : Promise

Handler function should accept 2 arguments, the first one being the parsed message Body value, and the second one being the whole message object. It will be called once for every message found in the queue (depending on the queue's concurrency).

The options object is optional and accept the following properties:

  • keepMessages (boolean): To avoid deleting the message after processing it. Default is false.
  • messageAttributesNames (string array): The value which will be sent to the receiveMessage SQS method at the MessageAttributeNames property. Default value is ['All'].
  • attributeNames (string array): A list of attributes that need to be returned along with each message, within the Attributes property. Default value is ['All'].

After the handler returns (if it returns a Promise, SQS Quooler will wait for it to resolve), the item is automatically deleted from the queue. If your handler throws an error, or returns a rejected Promise, the item will not be removed from the queue.

myQueue.startProcessing((body, message) => {
  // body: {
  //   data: 'test',
  // }

  // message: {
  //   Body: '{"data":"test"}',
  //   ReceiptHandle: 'receipt handle',
  //   MessageAttributes: {
  //     custom_attribute: {
  //       StringValue: 'custom_attribute value',
  //       StringListValues: [],
  //       BinaryListValues: [],
  //       DataType: 'String'
  //     }
  //   }
  //   ...
  // }
})

Stop processing the queue

myQueue.stopProcessing () : Promise

myQueue.stopProcessing()

Purge the queue

myQueue.purge () : Promise

Deletes all messages in a queue

myQueue.purge()

License

You can check out the full license here

This project is licensed under the terms of the MIT license.