README

Basic Indexer

The objective of this module is to create and manage a basic indexed collection

How to import

CommonJS

const Indexer = require("basic-indexer").Indexer;

ES6 module syntax

import { Indexer } from "basic-indexer";

Browser import the min.js file.

<script type="text/javascript" src="basic-indexer.min.js">

How to use

Methods:

constructor(array, key = "id", keepIndex = false)
getArray(url, name)
getAll()
getOne(index)
get(...indexes)
set(index, object)

Examples

Regular example

index.js

const Indexer = require("basic-indexer").Indexer;

const index = new Indexer([
  {
    id: 1,
    name: "someName1",
  },
  {
    id: 3,
    name: "someName3",
  },
  {
    id: 2,
    name: "someName2",
  },
]);

const values = index.get(1, 3);
const array = index.getArray();
const allValues = index.getAll();
const value = index.getOne(1);

values contains:

[
  { name: "someName1" },
  { name: "someName3" },
]

array contains:

[
  { id: 1, name: 'someName1' },
  { id: 2, name: 'someName2' },
  { id: 3, name: 'someName3' }
]

allValues contains:

{
  '1': { name: 'someName1' },
  '2': { name: 'someName2' },
  '3': { name: 'someName3' }
}

value contains:

{ name: 'someName1' }

Keeping the keys

const Indexer = require("basic-indexer").Indexer;

const index = new Indexer(
  [
    {
      id: 1,
      name: "someName",
    },
    {
      id: 3,
      name: "someName",
    },
    {
      id: 2,
      name: "someName",
    },
  ],
  "id",
  true
);

const values = index.get(1, 2, 3);
const array = index.getArray();
const allValues = index.getAll();