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

multi-index

v0.0.2

Published

Multiple indexes on a single collection of objects

Downloads

14

Readme

Build status

Multi-Index: Containers with more than one index

Multi-index separates container storage from indexing. You store a set of objects and access them using any key you can compute from those objects.

Containers

Create a container:

import { Container, uniqueIndex, nonuniqueIndex } from 'multi-index';

interface Contact {
  id: string; // unique
  name: string;
  nickname: string;
  phone?: string;
}

const c = new Container<Contact>();

Everything works if you're using JavaScript, you'll just not bother with types:

const { Container, uniqueIndex, nonuniqueIndex } = require('multi-index');

const c = new Container();

Usually you'd add some indexes, but you can already add objects to that container:

const joeBloggs = { id: 17, name: 'Joe Bloggs', nickname: 'joe', phone: '+972-99-555-6666' };
c.add(joeBloggs)
 .add({ id: 19, name: 'Ariel Shaqed (Scolnicov)', nickname: 'ariels', phone: '+972-99-666-5555', })
 .add({ id: 23, name: 'Joseph', nickname: 'joe', });

You can also delete, but it has to be the same object you added:

c.delete(joeBloggs);

But let's keep Mr. Bloggs in there so we can look at indices...

c.add(joeBloggs);

Indices

Add a few indices:

const byId = uniqueIndex({ id }: Contact => id, 'by id').on(c);
const byNickname = nonuniqueIndex({ nickname }: Contact => nickname, 'by nickname').on(c);

Or in JavaScript, just don't add types to the functions:

const byId = uniqueIndex({ id } => id, 'by id').on(c);
const byNickname = nonuniqueIndex({ nickname } => nickname, 'by nickname').on(c);

Unique indices won't let you add the same element twice:

c.add({ id: 19, name: 'Impostor', nickname: 'ariels' });  // throws NonuniqueIndexError

(They also test for uniqueness if you add them to a container with existing indexes, so byNickname above could not be unique.)

Now you can look up elements:

byId.get(23);  // returns { id: 23, name: 'Joseph', nickname: 'joe' }
byNickname.get('joe');  // returns Set([{ id: 23, name: 'Joseph', nickname: 'joe' }, joeBloggs])

Related projects

  • indexify: A similar lightweight package, supports containers with multiple indexes. API is not type-safe for TypeScript. Less extensible.
  • bimap: A specific container with 2 indices. You could implement a bidirectional map using a multi-index container.
  • bim: Another bidirectional map.
  • mnemonist: A variety of lower-level data structures. Unfortunately does not include multi-indexed containers.
  • Boost multi_index: the ultimate multi-indexed container, for C++; highly performant.