Interface LdapTransport

The LDAP operations ldap-kit needs, whatever client does them. ldap-kit's API never shows the client's own types: ldaptsTransport (the default) can be replaced (another client, a fake in tests) without changing it.

interface LdapTransport {
    bind(dn: string, password: string): Promise<void>;
    close(): Promise<void>;
    search(
        base: string,
        options: TransportSearch,
    ): AsyncIterable<TransportEntry[]>;
}

Index

Methods

bind close search

Methods

bind

bind(dn: string, password: string): Promise<void>
A simple bind: an empty password must be refused before it gets here.
Parameters
- dn: string
- password: string
Returns Promise<void>
- Defined in packages/ldap-kit/src/transport.ts:12

close

close(): Promise<void>
Ends the session and closes the connection.

Returns Promise<void>
- Defined in packages/ldap-kit/src/transport.ts:16

search

search(base: string, options: TransportSearch): AsyncIterable<TransportEntry[]>
Every entry of a search, page by page when pageSize is set.
Parameters
- base: string
- options: TransportSearch
Returns AsyncIterable<TransportEntry[]>
- Defined in packages/ldap-kit/src/transport.ts:14