Giter Club home page Giter Club logo

hapi-sqs's Introduction

hapi-sqs

workflow codecov

This Hapi plugin simplifies interaction with Amazon Simple Queue Service (SQS) by providing a convenient way to use the AWS SDK for JavaScript (v3) with Hapi.js applications.

Installation

npm i hapi-sqs

Usage

First, register the plugin with your Hapi server:

const Hapi = require('@hapi/hapi');
const SQSPlugin = require('hapi-sqs');

const init = async () => {
  const server = Hapi.server({
    port: 3000,
    host: 'localhost',
  });

  await server.register({
    plugin: SQSPlugin,
    options: {
      region: 'us-east-1', // Replace with your desired AWS region
    }
  });

  // Add routes, start server, etc.
};

init();

The plugin will create an instance of QueueAdapter using the provided options and decorate the Hapi server toolkit with the sqs property.

Configuration

You can pass the following options when registering the plugin:

region (required) - The AWS region for your SQS resources (e.g., 'us-east-1'). Defaults to us-east-1.

sqsClient (optional) - An instance of the AWS SQS client. Defaults to the SQSClient from AWS SDK.

awsAccessKey (optional) - Your AWS access key id.

awsSecretKey (optional) - Your AWS secret key.

Example:

await server.register({
  plugin: SQSPlugin,
  options: {
    region: 'us-east-1',
    sqsClient: customSQSClient,
    awsAccessKey: 'your_access_key',
    awsSecretKey: 'your_secret_key'
  }
});

API

The plugin exposes the following method:

send(queueUrl, message, options)

Sends a message to the specified SQS queue.

queueUrl (required) - The URL of the target SQS queue.

message (required) - The message to send.

options (optional) - An object containing additional options for the SendMessageCommand.

Returns a Promise that resolves with the SendMessageCommand response.

Example

Here's an example of how to use the plugin in your Hapi routes:

server.route({
  method: 'POST',
  path: '/send',
  handler: async (request, h) => {
    const queueUrl = 'https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue';
    const message = 'Hello, world!';
    const options = { MessageGroupId: 'test-group' };

    try {
      const response = await h.sqs.send(queueUrl, message, options);
      return h.response(response).code(200);
    } catch (error) {
      return h.response(error).code(500);
    }
  },
});

hapi-sqs's People

Contributors

afgallo avatar snyk-bot avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.