ldap-pool/README.md

LDAP client connection pool

# LDAP Pool - a simple client pool for LDAP connections
## This API is promise-based - so as to work well with async/await flow control.



## Installation

```bash
$ npm install ldap-pool --save
```

## Usage

```typescript

import {Pool, LDAPPool, LDAPPoolClient} from 'ldap-pool';

let pool = new Pool({});
let pool = Pool.create({});  // same as above

// synchronous
let client = pool.getClientSync(); // returns a LDAPPoolClient synchronously

// asynchronous
pool.getClient().then(function(c: LDAPPoolClient){
   // gets an LDAPPoolClient asynchronously (the least active client)
});

```

The asynchronous getClient method is preferred, because this can guarantee we use a client that is
not already active. Although it shouldn't matter that much.

Here we have a full use cycle:

```typescript

const pool = Pool.create({
  connOpts: {
    url: url,
    reconnect: true,
    idleTimeout: 30000
  },
  size: 4,
  dn: 'uid=cdt_main.gen,OU=Generics,O=cco.nabisco.com',
  pwd: '<pwd>'
})


let client = pool.getClientSync();

client.search('foo', {}, function(err,res){
  
  // when you're done, return the client to the pool
  // this is important for performance, but *not* imperative for functionality/correctness
  client.returnToPool();
  
});

```