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

@universal-packages/adapter-resolver

v1.5.5

Published

Module loader based on adapter parameters.

Downloads

50,674

Readme

Adapter Resolver

npm version Testing codecov

Module loader based on adapter parameters.

Install

npm install @universal-packages/adapter-resolver

Global methods

resolveAdapter(options: Object)

Tries to infer an installed module name based on name and options, imports it and infers the desired export based on name and options.

import { resolveAdapter } from '@universal-packages/adapter-resolver'

const adapter = resolveAdapter({ name: 'redis', domain: 'token-registry', type: 'engine' })

console.log(adapter)

// > [class RedisEngine]

Options

Adapters need to follow the convention in order to be found. domain and name are use to infer the package name and type is used to infer the export name.

  • name String The name of the adapter, for example redis.

  • domain String The domain for which the adapter will work for example if the adapter is redis and is meant to work with @universal-packages/token-registry you provide here token-registry.

  • internal Object An object which keys match an internal adapter provided by the root library.

    import { resolveAdapter } from '@universal-packages/adapter-resolver'
    
    const adapter = resolveAdapter('local', { internal: { domain: 'token-registry', type: 'engine', local: LocalAdapter } })
    
    console.log(adapter)
    
    // > [class LocalAdapter]
  • type String The package needs to export something in the format <name><type>, for example if the adapter is an "engine", you provide here engine and it will internally will come up with different case variations of the format to find the export ex: redisEngine, RedisEngine, redis_engine.

gatherAdapters(options: Object)

Gather of the adapters of a type under the same domain.

import { gatherAdapters } from '@universal-packages/adapter-resolver'

const adapters = gatherAdapters({ domain: 'token-registry', type: 'engine' })

console.log(adapters)

// > { redis: [class RedisEngine], local: [class LocalEngine] }

Options

  • domain String The domain under which the adapters are meant to work, for example all engines for @universal-packages/token-registry will have the same domain token-registry.

  • internal Object An object of named internal adapters provided by the root library to be mixed with the gathered adapters.

    import { gatherAdapters } from '@universal-packages/adapter-resolver'
    
    const adapters = gatherAdapters({ domain: 'token-registry', type: 'engine', internal: { local: InternalAdapter } })
    
    console.log(adapters)
    
    // > { internal: [class InternalAdapter], redis: [class RedisEngine], local: [class LocalAdapter] }
  • type String The type of the adapters, for example engine.

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

License

MIT licensed.