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

double-cycle

v0.1.5

Published

a specialized datastructure with double indexing and queue-based entry cycling

Downloads

6

Readme

double-cycle

A specialized datastructure with double indexing and queue-based entry cycling.

Note: the indexes are not really unique, and inserting a single entry into the structure which already exists in the structure will create duplicates. To avoid this, you can use the replaceKing or replaceQueen methods, which force an entire king or queen chain to match the provided mappings.

Install

npm

$ npm install double-cycle

github

$ git clone https://github.com/skeggse/double-cycle.git

Test

Run any of the following.

$ mocha
$ npm test
$ make test

remember to npm install!

API

The king and queen parameters to most of these methods are designed to take strings, or Objects which are unique when converted to strings. These parameters are the keys for the King and Queen indexes within the datastructure.

insert(king, queen, object)

Inserts an object into the datastructure (no duplicate checking), and indexes the object by the king and queen parameters.

var create = require('double-cycle');
var cycle = create();

// these insert items into the structure
cycle.insert('123', 'abc', {thing: 1});
cycle.insert('123', 'bcd', {thing: 2});
cycle.insert('234', 'abc', {thing: 3});
cycle.insert('234', 'bcd', {thing: 4});
cycle.insert('234', 'bcd', {thing: 5}); // this does not replace the last insert

// cycle now contains five entries, indexable by two kings and two queens

replaceKing|Queen(king|queen, object)

Replaces all entries with the entries in the provided object by the given king or queen index. This will add, remove or update entries as it sees fit, and it guarantees that all entries will be unique as far as the indexes are concerned.

The provided object consists of keys representing a queen index and values representing the corresponding data to be stored.

var create = require('double-cycle');
var cycle = create();

cycle.insert('123', 'abc', {thing: 1});
cycle.insert('123', 'bcd', {thing: 2});
cycle.insert('234', 'abc', {thing: 3});
cycle.insert('234', 'bcd', {thing: 4});

cycle.replaceKing('234', {
  'abc': {thing: 5},
  'cde': {thing: 6}
});

// cycle now contains four items:

// 123/abc/{thing: 1}
// 123/bcd/{thing: 2}
// 234/abc/{thing: 5}
// 234/bcd/{thing: 6}

nextKing|Queen(king|queen)

Retrieves the next entry in the sequence for the given king of queen. This effectively allows any key to be a round-robin queue, especially useful for delegating to known instances of services.

This function does not alter the entries stored in the structure, it only rotates the relevant chain.

var create = require('double-cycle');
var cycle = create();

cycle.insert('123', 'abc', {thing: 1});
cycle.insert('123', 'bcd', {thing: 2});
cycle.insert('234', 'abc', {thing: 3});
cycle.insert('234', 'bcd', {thing: 4});

cycle.nextKing('123'); // {thing: 2}
cycle.nextKing('123'); // {thing: 1}
cycle.nextKing('123'); // {thing: 2}

removeKing|Queen(king|queen)

Removes all entries indexed by the given king or queen.

var create = require('double-cycle');
var cycle = create();

cycle.insert('123', 'abc', {thing: 1});
cycle.insert('123', 'bcd', {thing: 2});
cycle.insert('234', 'abc', {thing: 3});
cycle.insert('234', 'bcd', {thing: 4});

cycle.removeKing('123');

// cycle now contains two items:

// 234/abc/{thing: 3}
// 234/bcd/{thing: 4}

More Examples

var create = require('double-cycle');
var cycle = create();

// these insert items into the structure
cycle.insert('123', 'abc', {thing: 1});
cycle.insert('123', 'bcd', {thing: 2});
cycle.insert('234', 'abc', {thing: 3});
cycle.insert('234', 'bcd', {thing: 4});
cycle.insert('234', 'bcd', {thing: 5}); // this does not replace the last insert

cycle.nextKing('123'); // {thing: 2}
cycle.nextKing('123'); // {thing: 1}
cycle.nextKing('123'); // {thing: 2}

cycle.nextKing('234'); // {thing: 5}
cycle.nextKing('234'); // {thing: 4}
cycle.nextKing('234'); // {thing: 3}
cycle.nextKing('234'); // {thing: 5}

cycle.nextQueen('abc'); // {thing: 3}
cycle.nextQueen('abc'); // {thing: 1}
cycle.nextQueen('abc'); // {thing: 3}

cycle.nextQueen('bcd'); // {thing: 5}
cycle.nextQueen('bcd'); // {thing: 4}
cycle.nextQueen('bcd'); // {thing: 2}

Browser Compatibility

It might work! Designed only for a Node runtime environment, however.

Unlicense / Public Domain

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>