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

edged

v1.0.4

Published

Purge items at the edge of the network

Downloads

4

Readme

edged - reverse proxy client

The edged Node.js package implements a client for a tiny subset of the Fastly reverse proxy API. And even that’s bragging, what it does is purging single items at the edge of the network using that API.

Types

class Edged

Edged is the main object in this package.

Properties

  • token: String

Your Edged API token.

  • auth: String

Optionally basic authentication credentials can be passed.

  • agent: http.Agent | https.Agent

You might want to configure the agent to use keep-alive connections.

  • log: { fatal, error, warn, info, debug, trace }

A conventional logging API is supported.

  • port: Number

The port to connect to. 443 is the default.

  • timeout: Number

Limits the time the socket is allowed to be idle, defaults to ten seconds.

Class properties

  • action: { String: Symbol }

Enumerates possible actions. These are the things you can do with the client.

Creating a client

const { Edged } = require('edged')

const client = new Edged(token)

By default, Fastly doesn’t require an API token for purging.

Purging URLs

cb (Error | undefined, Number, String)

The callback of these methods receives an error if something went wrong, the HTTP status code of the response, and its body.

client.purgeByURL (uri, cb)

Purges a single URL executing the callback when done.

client.softPurgeByURL (uri, cb)

Marks URL as outdated (stale) instead of permanently purging it, executing the callback when done.

Streaming API

Often times you want to purge not just one URL, but many, maybe URLs you receive from a stream. 🚰

{ statusCode, uri, body }

Result objects, readable from these streams, contain an HTTP status code received from Fastly, the URL that was attempted to purge, and the body of the HTTP response parsed as JSON if possible.

Edged.createStream (client)

Returns a flexible action stream, to which you write { Edged.action, uri } and read result objects.

Edged.createURLStream (client, Edged.action)

Returns a specialized stream for an action you choose up-front. Write URLs, as String or URL types, to this stream.

Installing

With npm, do:

$ npm install edged

License

MIT License