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

@shutterstock/kinesis-helpers

v1.0.15

Published

Helper classes for `@aws-sdk/client-kinesis`

Downloads

7

Readme

npm (scoped) License: MIT API Docs Build - CI Package and Publish Publish Docs

Overview

Helper classes for the AWS v3 SDK for JS Kinesis Client (@aws-sdk/client-kinesis).

KinesisRetrier will retry failed records with a "successful" PutRecordsCommand that has items marked as failed within the response, which then need to be retried.

KinesisBackgroundWriter will accept writes immediately if there is a concurrent writer slot available, and will block the caller until a slot becomes available if all slots are in use.

Getting Started

Installation

The package is available on npm as @shutterstock/kinesis-helpers

npm i @shutterstock/kinesis-helpers

Importing

import { KinesisBackgroundWriter, KinesisRetrier } from '@shutterstock/kinesis-helpers';

API Documentation

After installing the package, you might want to look at our API Documentation to learn about all the features available.

Features

  • KinesisRetrier
    • Kinesis batch put retrier
    • Batch puts return a list of items that were throttled
    • The batch is marked as succeeded (200 status code) even though items failed
    • As a result, the built-in AWS SDK retry logic will not retry the items in the batch that were throttle
  • KinesisBackgroundWriter
    • Accepts writes immediately if there is a concurrent writer slot available
    • Blocks the caller until a slot becomes available if all slots are in use
    • Collects and exposes errors so the caller can detect if errors have been happening

Contributing

Setting up Build Environment

  • nvm use
  • npm i
  • npm run build
  • npm run lint
  • npm run test

Running Examples

kinesis-retrier

  1. Create Kinesis Data Stream using AWS Console or any other method
    1. Example: aws kinesis create-stream --stream-name kinesis-helpers-test-stream --shard-count 1
    2. Default name is kinesis-helpers-test-stream
    3. 1 shard is sufficient
    4. 1 day retention is sufficient
    5. No encryption is sufficient
    6. On-demand throughput is sufficient
  2. npm run example:kinesis-retrier
    1. If the stream name was changed: KINESIS_STREAM_NAME=my-stream-name npm run example:kinesis-retrier

kinesis-background-writer

  1. Create Kinesis Data Stream using AWS Console or any other method
    1. Example: aws kinesis create-stream --stream-name kinesis-helpers-test-stream --shard-count 1
    2. Default name is kinesis-helpers-test-stream
    3. 1 shard is sufficient
    4. 1 day retention is sufficient
    5. No encryption is sufficient
    6. On-demand throughput is sufficient
  2. npm run example:kinesis-background-writer
    1. If the stream name was changed: KINESIS_STREAM_NAME=my-stream-name npm run example:kinesis-background-writer