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

anyfetch-file-hydrater

v0.2.19

Published

Create file hydrater for AnyFetch.

Downloads

16

Readme

AnyFetch file hydrater

Build StatusDependency Status Coverage Status NPM version

Base library for file hydration on http://anyfetch.com.

This library allows you to create a hydrater server from a single function. Taking a file path and initial data, it should return improved or augmented data.

Read first

To better understand the role of "hydraters", read the dedicated documentation page.

Usage

'use strict';

var anyfetchFileHydrater = require('anyfetch-file-hydrater');

/**
 * Hydration function, to add metadata to the document
 *
 * @param {String} filePath Path to the file from which hydrate, downloaded for you on the filesystem
 * @param {Object} document Data currently known (from previous hydraters, or from providers). Always includes `document_type`, `metadata`, `data` and `actions` keys.
 * @param {Object} changes Convenience object provided with empty keys `document_type`, `metadata`, `data` and `actions`. Add your changes in there.
 * @param {Function} cb(err, changes) Call this with an error if any, or pass your changes as second parameter.
 */
var myHydrationFunction = function(path, document, changes, cb)
  // Extract interesting stuff from the file...
  // Improve the document...

  cb(err, changes);
};

var config = {
  'hydrater_function': myHydrationFunction
};

var hydrationServer = anyfetchFileHydrater.createServer(config);
hydrationServer.listen(8000);

You're all set! Your server is running on port 8000. Access /hydrate with a standard AnyFetch POST request to start hydrating your file.

POST <your_hydrater_server_url>/hydrate
  {
    file_path: <url-file-to-hydrate>
    callback: <url-to-ping>
    document: {base document}
  }

In some cases, you may want to bypass the lib and send the result yourself. The property cb.callbackUrl tells you where to send the data back to the client. After having sent the data, call cb() without any error or document. This will finalize hydration, clean the file and start the next task.

Optional parameters

createServer() takes an object hash for argument. hydrater_function is mandatory, optional values includes:

  • concurrency: max number of simultaneous calls to your hydrater function (default: 1)
  • logger: function to use for logging error and success. It will get called with strings when a task is started or ended. When an error occured, you'll get the path of the file, and the err as second argument).

Errors

You may use require('anyfetch-file-hydrater').hydrationError as a special error to inform the hydration was unable to complete, and should not be tried again:

var myHydrationFunction = function(filePath, document, cb) {
  // Do stuff with the file...
  cb(new anyfetchFileHydrater.hydrationError("Corrupted file"));
};

For other (transient) errors, use standard Error objects.