Skip to main content

LdapClient.searchStreaming()

Home > @backstage/plugin-catalog-backend-module-ldap > LdapClient > searchStreaming

Performs an LDAP search operation, calls a function on each entry to limit memory usage

Signature:

searchStreaming(dn: string, options: SearchOptions, f: (entry: SearchEntry) => Promise<void> | void): Promise<void>;

Parameters

Parameter

Type

Description

dn

string

The fully qualified base DN to search within

options

SearchOptions

The search options

f

(entry: SearchEntry) => Promise<void> | void

The callback to call on each search entry

**Returns:**

Promise<void>