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

fs-browser

v1.0.0

Published

A package that allows you to paginate the file system.

Downloads

159

Readme

fs-browser

A package that allows you to paginate the file system. The items will always be fetched in order of folders first and after that the files.

Usage:

Constructor options

constructor( defaultLimit = DEFAULT_LIMIT, safeMode = true )

  • defaultLimit is by default how big a page will be ( if no limit is explicitly passed in the other methods )
  • safeMode - if this is set to true then only files that can be accessed by node will be returned
  • Safe Mode check: await stat( absItemName ).catch( ()=>{ return false; } );

Exported Functions:

async getAllItems( String directory, mixed nextToken = '', Number limit = this.defaultLimit ): Promise: Object

  • If next token is End Of Data (EOD) token, there will be no operations done and the response will be returned with EOD and hasMore set to false
  • You can set the limit to -1 in which case all items will be fetched
  • Directory is the absolute or relative path to the folder you want to browse
  • nextToken should be passed only if you have one from before
  • limit is the amount of items to fetch
  • Folders will be fetched first and after that the files
  • returned promise will be resolved to { nextToken: String, items: Array, hasMore: Boolean }
  • nextToken should be passed to the next time getAllItems is called
  • items is going to be an array of absolute item names
  • hasMore is going to be a flag if there is more data

async getDirectories( String directory, mixed nextToken = '', Number limit = this.defaultLimit ): Promise: Object

  • The same as getAllItems but hasMore will be false if End Of Data is reached for the folders
  • Only directories will be fetched

async getFiles( String directory, mixed nextToken = '', Number limit = this.defaultLimit ): Promise: Object

  • The same as getAllItems but hasMore will be false if End Of Data is reached for the files
  • Only files will be fetched

Notes:

  • nextToken can successfully be passed around the different methods but you won't get the full amount of data if the previous method is fully finished fetching data. This behaviour is discouraged