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

@web4/bitweb-dns

v1.0.0

Published

Issue DNS lookups for BIT archives using HTTPS requests to the target host.

Downloads

11

Readme

deprecated See @web4/dns for similar functionality.

bitweb-dns

Issue DNS lookups for BIT archives using HTTPS requests to the target host. Keeps an in-memory cache of recent lookups.

API

var bitDns = require('@web4/bitweb-dns')()

// or, if you have a custom protocol
var bitDns = require('@web4/bitweb-dns')({
    recordName: /* name of .well-known file */
    protocolRegex: /* RegExp object for custom protocol */,
    hashRegex: /* RegExp object for custom hash i.e. */,
    txtRegex: /* RegExp object for DNS TXT record of custom protocol */,
})

// example: 
var cabalDns = require('@web4/bitweb-dns')({
    recordName: 'cabal',
    hashRegex: /^[0-9a-f]{64}?$/i,
    protocolRegex: /^cabal:\/\/([0-9a-f]{64})/i,
    txtRegex: /^"?cabalkey=([0-9a-f]{64})"?$/i
})

// resolve a name: pass the hostname by itself
bitDns.resolveName('foo.com', function (err, key) { ... })
bitDns.resolveName('foo.com').then(key => ...)

// dont use cached 'misses'
bitDns.resolveName('foo.com', {ignoreCachedMiss: true})

// dont use the cache at all
bitDns.resolveName('foo.com', {ignoreCache: true})

// dont use dns-over-https
bitDns.resolveName('foo.com', {noDnsOverHttps: true})

// dont use .well-known/bit
bitDns.resolveName('foo.com', {noWellknownBit: true})

// list all entries in the cache
bitDns.listCache()

// clear the cache
bitDns.flushCache()

// configure the DNS-over-HTTPS host used
var bitDns = require('@web4/bitweb-dns')({
  dnsHost: 'dns.google.com',
  dnsPath: '/resolve'
})

// use a persistent fallback cache
// (this is handy for persistent dns data when offline)
var bitDns = require('@web4/bitweb-dns')({
  persistentCache: {
    read: async (name, err) => {
      // try lookup
      // if failed, you can throw the original error:
      throw err
    },
    write: async (name, key, ttl) => {
      // write to your cache
    }
  }
})

// emits some events, mainly useful for logging/debugging
bitDns.on('resolved', ({method, name, key}) => {...})
bitDns.on('failed', ({method, name, err}) => {...})
bitDns.on('cache-flushed', () => {...})

Spec

Option 1 (DNS-over-HTTPS). Create a DNS TXT record witht he following schema:

bitkey={key}

Option 2 (.well-known/bit). Place a file at /.well-known/bit with the following schema:

{bit-url}
TTL={time in seconds}

TTL is optional and will default to 3600 (one hour). If set to 0, the entry is not cached.