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

ParameterTypeDescription
dnstringThe fully qualified base DN to search within
optionsSearchOptionsThe search options
f(entry: SearchEntry) => Promise<void> | voidThe callback to call on each search entry

Returns:

Promise<void>