# indexden

> A client for IndexDen (indextank)

Latest version **0.0.4** (published 2013-05-21) · BSD license · 0 weekly downloads

## Install

```sh
npm install indexden
pnpm add indexden
yarn add indexden
bun add indexden
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2013-05-21 |
| First published | 2012-12-06 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.4.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Adriano Cola |
| Maintainers | adrianocola |
| Keywords | indexden, indextank |

## Links

- npm: https://www.npmjs.com/package/indexden
- Repository: https://github.com/adrianocola/indexden-node
- npm.io page: https://npm.io/package/indexden

## Dependencies (1)

- [spore](https://npm.io/package/spore.md) 0.x

## Recent versions

- 0.0.4 (latest) — 2013-05-21
- 0.0.3 — 2012-12-07
- 0.0.2 — 2012-12-07
- 0.0.1 — 2012-12-06

## README

IndexDen Node Client
=====================

A node.js client for indexden (http://indexden.com/) that can also be used with indextank.

This project was based in this [gist](https://gist.github.com/1023154) by [francois2metz](https://github.com/francois2metz)

## Installation

```
npm install indexden
```

## Connecting to indexden server

```javascript
indexDenClient = require('indexden').connect({
    url: "index_den_url",    //default: http://localhost:20220
    user: "index_den_username",  //optional
    pass: "index_den_password"  //optional
});
```

## Executing commands on indexden

```javascript

//create a new index
indexDenClient.createIndex("test_index",function(err,index){

    //add a new document to the created index
    indexDenClient.createDocuments("test_index",{docid:"1",fields:{text:"Some text to serve as example"}},function(err){

        //search for the word "example"
        indexDenClient.search("test_index","example",{fetch: "*"},function(err,docs,response){
                console.log(docs); //print the document created in the previous step
            });

    });

});

```

Check the file [index.js](https://github.com/adrianocola/indexden-node/blob/master/index.js) for the complete list of methods and the parameters each methods accepts.


## License

Copyright (c) 2012 Adriano Cola

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

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 OR COPYRIGHT HOLDERS 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.

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