arangojs/index.d.ts

The official ArangoDB JavaScript driver.

/**
 * ```js
 * import arangojs, { aql, Database } from "arangojs";
 * ```
 *
 * The "index" module is the default entry point when importing the arangojs
 * module or using the web build in the browser.
 *
 * If you are just getting started, you probably want to use the
 * {@link arangojs} function, which is also the default export of this module,
 * or the {@link database.Database} class for which it is a wrapper.
 *
 * @packageDocumentation
 */
import { Config } from "./connection.js";
import { Database } from "./database.js";
/**
 * Creates a new `Database` instance with its own connection pool.
 *
 * This is a wrapper function for the {@link database.Database:constructor}.
 *
 * @param config - An object with configuration options.
 *
 * @example
 * ```js
 * const db = arangojs({
 *   url: "http://127.0.0.1:8529",
 *   databaseName: "myDatabase",
 *   auth: { username: "admin", password: "hunter2" },
 * });
 * ```
 */
export declare function arangojs(config?: Config): Database;
/**
 * Creates a new `Database` instance with its own connection pool.
 *
 * This is a wrapper function for the {@link database.Database:constructor}.
 *
 * @param url - Base URL of the ArangoDB server or list of server URLs.
 * Equivalent to the `url` option in {@link connection.Config}.
 *
 * @example
 * ```js
 * const db = arangojs("http://127.0.0.1:8529", "myDatabase");
 * db.useBasicAuth("admin", "hunter2");
 * ```
 */
export declare function arangojs(url: string | string[], name?: string): Database;
export default arangojs;
export { aql } from "./aql.js";
export { Database } from "./database.js";
//# sourceMappingURL=index.d.ts.map