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

localdrive

v1.12.2

Published

File system interoperable with Hyperdrive

Downloads

4,829

Readme

localdrive

File system API that is similar to Hyperdrive

npm i localdrive

Usage

const Localdrive = require('localdrive')

const drive = new Localdrive('./my-project')

await drive.put('/blob.txt', Buffer.from('example'))
await drive.put('/images/logo.png', Buffer.from('..'))
await drive.put('/images/old-logo.png', Buffer.from('..'))

const buffer = await drive.get('/blob.txt')
console.log(buffer) // => <Buffer ..> "example"

const entry = await drive.entry('/blob.txt')
console.log(entry) // => { key, value: { executable, linkname, blob, metadata } }

await drive.del('/images/old-logo.png')

await drive.symlink('/images/logo.shortcut', '/images/logo.png')

for await (const file of drive.list('/images')) {
  console.log('list', file) // => { key, value }
}

const rs = drive.createReadStream('/blob.txt')
for await (const chunk of rs) {
  console.log('rs', chunk) // => <Buffer ..>
}

const ws = drive.createWriteStream('/blob.txt')
ws.write('new example')
ws.end()
ws.once('close', () => console.log('file saved'))

API

const drive = new Localdrive(root, [options])

Creates a drive based on a root directory. root can be relative or absolute.

Available options:

{
  followLinks: false, // If enabled then `entry(key)` will follow the `linkname`
  metadata: { // Hook functions are called accordingly
    get (key) {},
    put (key) {},
    del (key) {}
  },
  atomic: false, // Enable atomicity for file writing (tmp file and rename)
  roots: {} // For mapping key prefixes to different roots
}

The metadata hook del() could be called with non-existing metadata keys.

drive.root

String with the resolved (absolute) drive path.

drive.supportsMetadata

Boolean that indicates if the drive handles or not metadata. Default false.

If you pass opts.metadata hooks then supportsMetadata becomes true.

await drive.put(key, buffer, [options])

Creates a file at key path in the drive. options are the same as in createWriteStream.

const buffer = await drive.get(key, [options])

Returns the blob at key path in the drive. If no blob exists, returns null.

It also returns null for symbolic links.

options are the same as in drive.entry method.

const entry = await drive.entry(key, [options])

Returns the entry at key path in the drive. It looks like this:

{
  key: String,
  value: {
    executable: Boolean,
    linkname: null,
    blob: {
      byteOffset: Number,
      blockOffset: Number,
      blockLength: Number,
      byteLength: Number
    },
    metadata: null
  },
  mtime: Number
}

Available options:

{
  follow: false // Follow symlinks, 16 max or throws an error
}

await drive.del(key)

Deletes the file at key path from the drive.

await drive.symlink(key, linkname)

Creates an entry in drive at key path that points to the entry at linkname.

If a blob entry currently exists at key path then it will get overwritten and drive.get(key) will return null, while drive.entry(key) will return the entry with symlink information.

const comparison = drive.compare(entryA, entryB)

Returns 0 if entries are the same, 1 if entryA is older, and -1 if entryB is older.

const iterator = drive.list([folder], [options])

Returns a stream of all entries in the drive inside of specified folder.

Available options:

{
  ignore: String || Array // Ignore file and folders by name.
}

const iterator = drive.readdir([folder])

Returns a stream of all subpaths of entries in drive stored at paths prefixed by folder.

const mirror = drive.mirror(out, [options])

Efficiently mirror this drive into another. Returns a MirrorDrive instance constructed with options.

Call await mirror.done() to wait for the mirroring to finish.

const rs = drive.createReadStream(key, [options])

Returns a stream to read out the blob stored in the drive at key path.

Available options:

{
  start: Number,
  end: Number,
  length: Number
}

start and end are inclusive.
length overrides end, they're not meant to be used together.

const ws = drive.createWriteStream(key, [options])

Stream a blob into the drive at key path.

Available options:

{
  executable: Boolean
}

Examples

Metadata hooks

Metadata backed by Map:

const meta = new Map()
const metadata = {
  get: (key) => meta.has(key) ? meta.get(key) : null,
  put: (key, value) => meta.set(key, value),
  del: (key) => meta.delete(key)
}

const drive = new Localdrive('./my-app', { metadata })

// ...

Note: metadata.del() will also be called when metadata is null:

await drive.put('/file.txt', Buffer.from('a')) // Default metadata is null

License

Apache-2.0