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

beach-body

v1.0.0

Published

zero-dependency util to read and validate the body of a readable stream

Downloads

8

Readme

beach-body

NPM Version NPM Downloads Build

zero-dependency util to read and validate the body of a readable stream

Install

Yarn

yarn add beach-body

NPM

npm install beach-body

API

import getBody from 'beach-body';

getBody(stream: Readable, options?: BeachBodyOptions): Promise<string>

BeachBodyOptions

| property | type | default | description | | ---------- | ----------------------------- | ----------- | -------------------------------------------- | | length | number | undefined | undefined | Expected length in bytes of the content | | limit | number | string | undefined | undefined | Maximum allowed size in bytes of the content | | encoding | BufferEncoding | undefined | utf8 | Encoding to decode the stream buffer with |

Errors

Types

The errors from this module have a type property which allows for the programmatic determination of the type of error returned.

entity.too.large

This error will occur when the limit option is specified, but the stream has an entity that is larger.

request.aborted

This error will occur when the request stream is aborted by the client before reading the body has finished.

request.size.invalid

This error will occur when the length option is specified, but the stream has emitted more bytes.

stream.encoding.set

This error will occur when the given stream has an encoding set on it, making it a decoded stream. The stream should not have an encoding set and is expected to emit Buffer objects.

Examples

Simple Node example

const http = require('http');
const getBody = require('beach-body');

const hostname = '127.0.0.1';
const port = 3000;

const server = http.createServer(async (req, res) => {
  const body = await getBody(req, {
    length: req.headers['content-length'],
    limit: '1mb',
  });

  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end(body);
});

License

MIT