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

s3-poller

v1.0.0

Published

Fetch and configurably poll a JSON resource from S3

Downloads

2

Readme

s3-poller

Fetch a JSON object from S3. Poll it for updates. Refetch it only if it has changed.

Usage

Fairly self-documenting. See index.js comments for nitty-gritty. Here are the basics:

const poller = new Poller({
	bucket: 'my-bucket',
	key: 'path/to/some.json'
});

poller.getCurrentValue(); // undefined
poller.getLastModified(); // undefined

await poller.getObject(); // fetch from S3
await poller.getObject(); // already cached; returns cached copy

assert(poller.getCurrentValue() === await poller.getObject());

poller.getLastModified(); // Date

await poller.getUpdate(); // fetch from S3, even if cached, but only if modified since last fetch

poller.onUpdate(listenerFunction, another, yetAnother, ...); // call you back when updates happen
poller.poll(60 * 60 * 1000); // check every hour

poller.offUpdate(another, yetAnother); // remove these listeners

poller.poll(2 * 60 * 60 * 1000); // change polling inteval, same listeners

poller.cancelPoll(); // stop polling, listeners stay registered

poller.removeListeners(); // remove all listeners

(await is ES7-speak for Promises. You don't need ES7, you can just use .then() etc.)

Useful constructor options:

  • bucket, key - obvious, required
  • initialValue - preset the interally cached value
  • lastModified - preset the last modified date
  • updateInterval - preset the update interval (ms), AND start polling immediately
  • updateListener - add an update listener; you can give an array of listeners too
  • s3Config - this gets passed into the AWS.S3() constructor call

This thing will barf if the object it receives isn't JSON. You can catch that error from getObject() or getUpdate(). Polling just discards the error for the time being.

Legal

Copyright (c) 2016 Datanalytics, Inc. d/b/a Juristat.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0