🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

@types/ldapjs-client

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/ldapjs-client

TypeScript definitions for ldapjs-client

0.1.5
ts4.5
ts4.6
ts4.7
ts4.8
ts4.9
ts5.0
ts5.1
ts5.2
ts5.3
ts5.4
ts5.5
ts5.6
ts5.7
ts5.8
ts5.9
latest
Version published
Weekly downloads
837
2.2%
Maintainers
1
Weekly downloads
 
Created

Installation

npm install --save @types/ldapjs-client

Summary

This package contains type definitions for ldapjs-client (https://github.com/zont/ldapjs-client#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ldapjs-client.

index.d.ts

declare namespace LdapClient {
    interface Change {
        operation: "add" | "delete" | "replace";
        modification: {
            [key: string]: any;
        };
    }

    interface SearchOptions {
        scope?: string | undefined;
        filter?: string | undefined;
        attributes?: string[] | undefined;
        sizeLimit?: number | undefined;
        timeLimit?: number | undefined;
        typesOnly?: boolean | undefined;
    }

    interface ClientOptions {
        url: string;
        tlsOptions?: object | undefined;
        timeout?: number | undefined;
    }
}

declare class LdapClient {
    constructor(options: LdapClient.ClientOptions);

    /**
     * Adds an entry to the LDAP server.
     */
    add(dn: string, entry: object): Promise<any>;

    /**
     * Performs a simple authentication against the server.
     */
    bind(dn: string, password: string): Promise<any>;

    /**
     * Deletes an entry from the LDAP server.
     */
    del(dn: string): Promise<any>;

    /**
     * Disconnect from the LDAP server and do not allow reconnection.
     *
     * If the client is instantiated with proper reconnection options, it's
     * possible to initiate new requests after a call to unbind since the client
     * will attempt to reconnect in order to fulfill the request.
     *
     * Calling destroy will prevent any further reconnection from occurring.
     */
    destroy(): Promise<void>;

    /**
     * Performs an LDAP modify against the server.
     *
     * @param dn the DN of the entry to modify.
     * @param change update to perform (can be [Change]).
     */
    modify(dn: string, change: LdapClient.Change): Promise<any>;

    /**
     * Performs an LDAP modifyDN against the server.
     */
    modifyDN(dn: string, newName: string): Promise<any>;

    /**
     * Performs an LDAP search against the server.
     *
     * Note that the defaults for options are a 'base' search.
     */
    search(base: string, options: LdapClient.SearchOptions): Promise<unknown[]>;

    /**
     * Unbinds this client from the LDAP server.
     */
    unbind(): Promise<any>;
}

export = LdapClient;

Additional Details

  • Last updated: Tue, 07 Nov 2023 09:09:38 GMT
  • Dependencies: none

Credits

These definitions were written by Valerio Coltrè.

FAQs

Package last updated on 07 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts