Class Client

Description

this is a class to provide low level promise base interaction with ldap server

Hierarchy

Client

Index

Constructors

Properties

client config logger?

Methods

add bind compare connect del destroy extendedOp getConnectionStatus modifyAttribute modifyDn query queryAttributes unbind

Constructors

constructor

new Client(config: IClientConfig): Client
Parameters
- config: IClientConfig
Returns Client
- Defined in src/index.ts:88

Properties

`Private` client

client: Client

`Private` config

config: IClientConfig

`Private` `Optional` logger

logger?: Logger

Methods

add

add<T>(__namedParameters: AddFnInput<T>): Promise<boolean>
Performs an add operation against the LDAP server.

Description
Allows you to add an entry (which is just a plain JS object)
Type Parameters
- T = any
Parameters
- __namedParameters: AddFnInput<T>
Returns Promise<boolean>
- Defined in src/index.ts:230

bind

bind(input?: BindFnInput): Promise<Client>
Returns
a connected ldap client that is useful for use flexibility of ldap.js directly.
Parameters
- Optional input: BindFnInput
Returns Promise<Client>
- Defined in src/index.ts:110

compare

compare<T>(__namedParameters: CompareFnInput<T>): Promise<undefined | boolean>
Performs a LDAP compare operation with the given attribute and value against the entry referenced by dn.
Type Parameters
- T = any
Parameters
- __namedParameters: CompareFnInput<T>
Returns Promise<undefined | boolean>
- Defined in src/index.ts:257

`Private` connect

connect(): Promise<Client>
bind to server if client is not already bound

Returns Promise<Client>
- Defined in src/index.ts:172

del

del(__namedParameters: DelFnInput): Promise<boolean>
Deletes an entry from the LDAP server.
Parameters
- __namedParameters: DelFnInput
Returns Promise<boolean>
- Defined in src/index.ts:294

destroy

destroy(): Promise<void>
unbind the connection and don't allow it to connect again.

Returns Promise<void>
- Defined in src/index.ts:162

extendedOp

extendedOp(__namedParameters: ExtendedOpFnInput): Promise<{ res: any; value: string }>
Description
Performs an extended operation against LDAP server.

Example
```
const {value} = await client.extendedOp('1.3.6.1.4.1.4203.1.11.3');
console.log('whois: ' + value);
```
Parameters
- __namedParameters: ExtendedOpFnInput
Returns Promise<{ res: any; value: string }>
- Defined in src/index.ts:322

getConnectionStatus

getConnectionStatus(): boolean
connection status

Returns boolean
- Defined in src/index.ts:105

modifyAttribute

modifyAttribute<T>(__namedParameters: ModifyAttributeFnInput<T>): Promise<boolean>
Performs a LDAP modify operation against attributes of the existing LDAP entity. This API requires you to pass in a Change object.
Type Parameters
- T = any
Parameters
- __namedParameters: ModifyAttributeFnInput<T>
Returns Promise<boolean>
- Defined in src/index.ts:391

modifyDn

modifyDn(__namedParameters: ModifyDnFnInput): Promise<boolean>
Description
Performs a LDAP modifyDN (rename) operation against an entry in the LDAP server. A couple points with this client API:
- There is no ability to set "keep old dn." It's always going to flag the old dn to be purged.
- The client code will automatically figure out if the request is a "new superior" request ("new superior" means move to a different part of the tree, as opposed to just renaming the leaf).
Parameters
- __namedParameters: ModifyDnFnInput
Returns Promise<boolean>
- Defined in src/index.ts:361

query

query<T>(__namedParameters: QueryFnInput<T>): Promise<SearchEntry[]>
Description
raw search to provided full flexibility
Type Parameters
- T = any
Parameters
- __namedParameters: QueryFnInput<T>
Returns Promise<SearchEntry[]>
- Defined in src/index.ts:182

queryAttributes

queryAttributes<T>(__namedParameters: QueryFnInput<T>): Promise<SearchEntryObject[]>
Description
raw search returns just attributes

// TODO: add Generic type for return data
Type Parameters
- T = any
Parameters
- __namedParameters: QueryFnInput<T>
Returns Promise<SearchEntryObject[]>
- Defined in src/index.ts:207

unbind

unbind(): Promise<void>
unbind connection

Returns Promise<void>
- Defined in src/index.ts:149

Generated using TypeDoc