# @eldynn/index

> A simple library to handle a directory of users and groups.

Latest version **1.2.1** (published 2019-05-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @eldynn/index
pnpm add @eldynn/index
yarn add @eldynn/index
bun add @eldynn/index
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2019-05-02 |
| First published | 2019-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 11.0.0 |
| Dependencies | 0 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Robin BAILLARGEAUX |
| Maintainers | eldynn |
| Keywords | typescript, library, users, groups |

## Links

- npm: https://www.npmjs.com/package/@eldynn/index
- Repository: https://github.com/Eldynn/index
- Homepage: https://github.com/Eldynn/index#readme
- Issues: https://github.com/Eldynn/index/issues
- npm.io page: https://npm.io/package/@eldynn/index

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.2.1 (latest) — 2019-05-02
- 1.2.0 — 2019-05-02
- 1.1.1 — 2019-04-22
- 1.1.0 — 2019-04-21
- 1.0.0 — 2019-04-20
- 0.0.4 — 2019-04-13
- 0.0.3 — 2019-04-11
- 0.0.2 — 2019-04-11
- 0.0.1 — 2019-04-11

## README

# [Index](https://github.com/Eldynn/index)

[![Top Language](https://img.shields.io/github/languages/top/Eldynn/index.svg)](https://github.com/Eldynn/index/blob/master/tsconfig.json)
[![License](https://img.shields.io/github/license/Eldynn/index.svg)](https://github.com/Eldynn/index/blob/master/LICENSE)
![npm bundle size](https://img.shields.io/bundlephobia/min/@eldynn/index.svg)

[![Version](https://img.shields.io/npm/v/@eldynn/index.svg)](https://www.npmjs.com/package/@eldynn/index)
[![CircleCI](https://circleci.com/gh/Eldynn/index.svg?style=svg)](https://circleci.com/gh/Eldynn/index)
[![Code Quality](https://api.codacy.com/project/badge/Grade/cbf285d5983d4bdb8c1e726b54c7fcd7)](https://app.codacy.com/app/contact_115/index?utm_source=github.com&utm_medium=referral&utm_content=Eldynn/index&utm_campaign=Badge_Grade_Settings)
[![Code Coverage](https://api.codacy.com/project/badge/Coverage/fe8538e1cc2e42748e6c634365d967dc)](https://www.codacy.com/app/contact_115/index?utm_source=github.com&utm_medium=referral&utm_content=Eldynn/index&utm_campaign=Badge_Coverage)

[![devDependencies](https://david-dm.org/Eldynn/Index/dev-status.svg)](https://david-dm.org/Eldynn/Index?type=dev)
[![Greenkeeper](https://badges.greenkeeper.io/Eldynn/index.svg)](https://greenkeeper.io/)
[![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/Eldynn/index/blob/master/package.json)
[![Commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## Description

A simple library to handle a directory of users and groups.

## Usage

### In browser environment

Extract the [latest release](https://github.com/Eldynn/index/releases/latest).

then

```html
<script type="text/javascript" src="Index/index.js"></script>
<script type="text/javascript">
  console.info(Index.Index, Index.User, Index.Group, Index.Member);
</script>
```

or (recommended)

```html
<script type="module">
  import { Index, User, Group, Member } from './Index/index.esm.js';
</script>
```

### In node environment

`npm install @eldynn/index`

```typescript
import { Index, User, Group, Member } from '@eldynn/index';
```

## [Documentation](https://eldynn.github.io/index/)

![Class Diagram](http://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/Eldynn/index/master/docs/index.puml)

## Contribute

If you want to contribute read [this guide](https://github.com/Eldynn/index/blob/master/CONTRIBUTING.md).

Use `npm run build`, the output is located in build/

Use `npm test` to run the test suites

Use `npm run docs` to generate the documentation in docs/

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