# cjs-indexing-hash

> auto-indexing hash - just add index name and logic

Latest version **1.3.0** (published 2024-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install cjs-indexing-hash
pnpm add cjs-indexing-hash
yarn add cjs-indexing-hash
bun add cjs-indexing-hash
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2024-10-03 |
| First published | 2020-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 65.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | akamaozu |
| Maintainers | akamaozu |

## Links

- npm: https://www.npmjs.com/package/cjs-indexing-hash
- npm.io page: https://npm.io/package/cjs-indexing-hash

## Dependencies (1)

- [cjs-sync-hooks](https://npm.io/package/cjs-sync-hooks.md) ^0.1.1

## Recent versions

- 1.3.0 (latest) — 2024-10-03
- 1.2.2 — 2022-12-23
- 1.2.1 — 2022-04-11
- 1.2.0 — 2022-03-28
- 1.1.1 — 2022-03-18
- 1.1.0 — 2022-03-15
- 1.0.1 — 2020-10-14
- 1.0.0 — 2020-10-08

## README

# cjs-indexing-hash
**lightweight key-value store with support for auto-updating indexes** *( indices? you know what i mean ... )*

[![npm version](https://badge.fury.io/js/cjs-indexing-hash.svg)](https://badge.fury.io/js/cjs-indexing-hash) [![Coverage Status](https://coveralls.io/repos/github/Akamaozu/cjs-indexing-hash/badge.svg?branch=master)](https://coveralls.io/github/Akamaozu/cjs-indexing-hash?branch=master)

---

### install
`npm i cjs-indexing-hash`

---

### how to use

#### create new instance (empty)
```js
var create_indexing_hash = require('cjs-indexing-hash'),
    indexing_hash = create_indexing_hash();
```

### create new instance from existing data
#### > objects
```js
var users = {
      batman: { is_cool: true },
      superman: { is_cool: false }
    },
    indexable_users = create_indexing_hash( users );
```
#### > arrays
```js
var users = [
      { id: batman, is_cool: true },
      { id: superman, is_cool: false }
    ],
    indexable_users = create_indexing_hash( users );
```
#### > strings
```js
var indexable_string = create_indexing_hash( 'why would you want to do this? who cares! it works!!!' );
```

### get entry
```js
// from object
var batman = indexable_users.get( 'batman' );

// from array
var batman = indexable_users.get( 0 );

// from string
var y = indexable_string.get( '2' );
```
### add entry
```js
indexable_users.add( 'wonder_woman', { is_cool: true });
```

### create index
```js
indexable_users.add_index( 'is-cool', function( entry, add_to_index ){
  if(  entry.is_cool == true ) add_to_index();
});
```

### get keys in index
```js
var cool_users = indexable_users.index_get( 'is-cool' );
```

### get keys in multiple indexes (indices)
```js
var cool_users_with_capes = indexable_users.intersect_indexes([ 'is-cool', 'has-cape' ]);
```

### hooks

#### default indexing-hash behavior
written in expected hook execution order

```js
// hook: key-created
//       * executes whenever an item is added to indexing-hash
hooks.add( 'key-created', 'update-collection-keys-cache', ({ key, val }) => {})
hooks.add( 'key-created', 'index-new-entry', ({ key, val }) => {})


// hook: key-deleted
//       * executes whenever an item is removed from indexing-hash
hooks.add( 'key-deleted', 'update-collection-keys-cache', ({ key, val }) => {})
hooks.add( 'key-deleted', 'remove-from-indexes', ({ key, val }) => {})

// hook: key-updated
//       * executes whenever an item in indexing-hash is updated
hooks.add( 'key-updated', 'update-indexes', ({ key, val }) => {})

// hook: index-created
//       * executes whenever an index is added to indexing-hash
hooks.add( 'index-created', 'populate-created-index', ({ name }) => {})
```

#### create custom indexing-hash behavior
```js
indexable_users.hooks.add( 'key-created', 'log-user-creation', ({ key, val }) => {
      const user = val
      console.log( `action=user-created id=${ key } cool=${ user.is_cool }` )
})

indexable_users.hooks.add( 'index-created', 'log-index-creation', ({ name }) => {
      console.log( `action=index-created name=${ name }` )
})

indexable_users.hooks.add( 'key-deleted', 'send-user-deletion-email', ({ key, val }) => {
      const user_at_deletion = val
      if (user_at_deletion.email) {
            // send email
            console.log( `action=send-deletion-email user=${ key }` )
      }
})
```

---
_Source: https://npm.io/package/cjs-indexing-hash · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._