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

serverless-elasticsearch-client

v1.1.1

Published

Elasticsearch client for AWS that plays nicely with serverless-offline and signed requests

Downloads

21

Readme

serverless-elasticsearch-client

serverless npm version CircleCI styled with prettier semantic-release

AWS Elasticsearch Client

Wrapper around elasticsearch-js client that plays nicely with AWS and serverless. Features include:

  • Uses http-aws-es to sign your requests so that they're valid in AWS
  • Plays nicely with serverless-offline's IS_OFFLINE environment variable
  • Uses sane default environment variables for AWS config

Table of Contents

Install

npm install --save serverless-elasticsearch-client

Usage

Use this as you would use the standard elasticsearch-js client.

const createEsClient = require('serverless-elasticsearch-client')
const client = createEsClient({ envPrefix: 'AWS_ES' })

API

Shared [options]

The following options are shared between the two methods below.

  • envPrefix {string} if this is set, DDB will look for config in environment variables prefixed by envPrefix.
  • region {string} if not set, DDB will look in ${envPrefix}_REGION. If envPrefix is not set, it looks at AWS_REGION. If still not found, when in serverless-offline mode, it will fall back to localhost
  • endpoint {string} if in serverless-offline mode, this defaults to http://localhost:8000
  • sslEnabled {boolean} defaults to true, if in serverless-offline mode, it is set to false

getClient([options])

Method: dynamo.getClient

Creates an AWS.DynamoDB with provided options.

var dynamo = require('serverless-elasticsearch-client')

const docClient = dynamo.getClient({
  envPrefix: 'AWS_DDB',
  maxRetries: 3
})

getDocumentClient([options])

Method: dynamo.getDocumentClient

Creates an AWS.DynamoDB.DocumentClient with provided options.

var dynamo = require('serverless-elasticsearch-client')

const docClient = dynamo.getDocumentClient({
  convertEmptyValues: true
})

Contribute

PRs accepted. Note that code uses standard styling.

License

MIT © Dan Caddigan