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

sniff-bytes

v0.1.11

Published

An npm library to sniff the file format of a binary buffer.

Downloads

22

Readme

sniff-bytes

An npm library to sniff the file format of a binary buffer.

import { sniffBytes, FileFormat } from 'sniff-bytes';

const IMAGE: string = `
P6
200 300
255
`.trim();

const BYTES: Uint8Array = new Uint8Array(IMAGE.split('').map(c => c.charCodeAt(0)));
const FORMAT: FileFormat = sniffBytes(BYTES.buffer);
console.log(FORMAT);
// {
//   name: 'Portable PixMap',
//   shortName: 'PPM',
//   mediaType: 'image/x-portable-pixmap',
//   extension: 'ppm'
// }

Build

  • To build locally, run npm run debug.
  • To publish a new patch version, run npm run release-patch.
  • To publish a new minor version, run npm run release-minor.
  • To publish a new major version, run npm run release-major.
  • To publish a custom version, run npm run release -- NNN where NNN is the desired version number.

Using Neon to create Rust libraries in npm

This repo also serves as a simple example for using Neon to build portable binary npm libraries implemented in Rust.

To build one of your own, follow this general recipe:

  • Create a GitHub repo.
  • Create a new free npm organization called @mylib, replacing mylib with your library's name.
  • Create a classic npm automation token and save it as a repo token NPM_TOKEN in the GitHub repo secrets.
  • Copy this repo's structure.
  • Change the package.json's neon.targets entry to replace @sniff-bytes with @mylib, again replacing mylib with your library's name.
  • Change the package.json and README.md of each binary prebuild package in the npm directory to replace sniff-bytes with mylib, again replacing mylib with your library's name.
  • Edit src/lib.rs (the Rust implementation of the binary module) and lib/index.cjs (the JavaScript wrapper) as you like.
  • Edit types/index.d.cts as appropriate to provide types for the (CommonJS) exports of lib/index.cjs and types/index.d.mts to re-export the (ESM) exports.
  • Edit the array of exports in lib/load.cjs to the complete set of exports of index.cjs.

(Many of these steps may still be automated by future versions of @neon-rs/cli.)

License

MIT