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

wadlrr

v0.3.1

Published

An interface for creating, extracting, modifying, and reading LRR WAD files.

Downloads

3

Readme

wadlrr Build Status Coverage Status

A Node.js interface for creating, extracting, modifying, and reading LRR WAD files.

API

indexOf

This function finds the index of a given path in a WAD file.

Parameters

  • wadMeta Object any valid WAD metadata object
  • filePath string the relative or absolute path of a file contained in the WAD

Returns Number the index that the file was found at

exists

This function checks if a file exists given path in a WAD file.

Parameters

  • wadMeta Object any valid WAD metadata object
  • filePath string the relative path of the file in question

Returns Boolean

getObjectFromFile

This function reads data for a given object from an open WAD file.

Parameters

  • fd Number file descriptor for the open WAD file
  • object Object the object's metadata

Returns Promise<Buffer> resolves to a buffer containing the object data

getObjectMeta

This function returns the object metadata at a given path in a WAD file or throws an error if the file doesn't exist.

Parameters

  • wadMeta Object any valid WAD metadata object
  • filePath string the relative path of a file contained in the WAD

Returns Object resolves to the object metadata

getObject

This function reads a buffer from a given WAD that represents the actual object data.

Parameters

  • wadMeta Object any valid WAD metadata object
  • object Object the object's metadata

Returns Promise<Buffer> resolves to a buffer containing the object data

getObjectAtPath

This function reads a buffer that represents object data at a given path.

Parameters

  • wadMeta Object any valid WAD metadata object
  • filePath string the object's internal path

Returns Promise<Buffer> a buffer containing the object data

getObjectStream

This function gets a read stream for a given object

Parameters

  • wadMeta Object any valid WAD metadata object
  • object Object the object's metadata

Returns ReadStream a read stream for the object

getObjectStreamAtPath

This function gets a stream for object data at a given path.

Parameters

  • wadMeta Object any valid WAD metadata object
  • filePath string the object's internal path

Returns ReadStream a read stream for the object

extract

This function extracts all files from a given WAD.

Parameters

  • wadMeta Object any valid WAD metadata object
  • outputPath string the base output path (optional, default path.basename(wadMeta.source,'.wad'))

Returns Promise resolves when all files have been extracted

parse

This function parses a WAD file's metadata.

Parameters

  • filename string the filename of the wad (actual or artificial)
  • data Buffer the raw file data buffer

Returns Object metadata describing the WAD

load

This function loads data from a file and parses it.

Parameters

  • wadPath string path to the WAD file itself

Returns Object metadata describing the WAD