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

@fuzzy-ai/web

v1.0.5

Published

Simple web client used by fuzzy.ai

Downloads

18

Readme

fuzzy.ai-web

A Web client library that does about what you'd expect it to. It supports persistent connections.

License

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

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Example


var web = require('fuzzy.ai-web');

myClient = new web.WebClient({timeout: 5000});

myClient.get("http://example.com/resource", function(err, response, body) {
  if (err instanceof web.ClientError) {
    // Fix it.
  } else if (err instanceof web.ServerError) {
    // retry request?
  } else if (err) {
    // Timeouts, lookup, other things like that
    console.error(err);
  } else {
    // Succcess!
    console.log(body);
  }
});

WebClient

This is the main class for running a Web client. It has the following methods.

  • constructor(props): Constructor takes named initialization properties as an argument. Currently the only property is timeout, which is how long to leave persistent connections open before closing them. If it's Infinity, never close it. If it's 0, close immediately (no persistent connections). If props is an integer instead of an object, use that as the timeout. timeout is zero by default.

  • request(method, url, headers, body, callback). Make an HTTP request with method method. url and headers are as expected. body is the body of the request, as a string, if any. callback is a function which receives err, response, and body. response is an http.IncomingMessage; body is the body of the response. err is an error; either a ClientError, ServerError, or maybe an error at a lower level of the stack (network, e.g.).

    There are convenience methods for HTTP methods, also.

  • get(url, headers, callback). Convenience for 'GET'.

  • post(url, headers, body, callback). Convenience for 'POST'.

  • head(url, headers, callback). Convenience for 'HEAD'.

  • put(url, headers, body, callback). Convenience for 'PUT'.

  • patch(url, headers, body, callback). Conenience for 'PATCH'.

  • delete(url, headers, callback). Convenience for 'DELETE'.

  • stop() Shut down the client, and disconnect any existing persistent connections. You should do this if you have non-zero timeout and your program is terminating, since otherwise the connections will be held open for the timeout period.

ClientError

This is a class for when an HTTP response comes back with a 4xx status code. It has the following properties:

  • url
  • verb
  • statusCode
  • headers
  • body

ServerError

This is a class for when an HTTP response comes back with a 5xx status code. It has the following properties:

  • url
  • verb
  • statusCode
  • headers
  • body