kuzzle-sdk/src/controllers/Index.d.ts

Official Javascript SDK for Kuzzle

import { BaseController } from "./Base";
import { JSONObject, ArgsDefault } from "../types";
export declare class IndexController extends BaseController {
    constructor(kuzzle: any);
    /**
     * Creates a new index
     *
     * @see https://docs.kuzzle.io/sdk/js/7/controllers/index/create/
     *
     * @param index Index name
     * @param options Additional options
     *    - `queuable` If true, queues the request during downtime, until connected to Kuzzle again
     *    - `timeout` Request Timeout in ms, after the delay if not resolved the promise will be rejected
     */
    create(index: string, options?: ArgsIndexControllerCreate): Promise<void>;
    /**
     * Deletes an index
     *
     * @see https://docs.kuzzle.io/sdk/js/7/controllers/index/delete/
     *
     * @param index Index name
     * @param options Additional options
     *    - `queuable` If true, queues the request during downtime, until connected to Kuzzle again
     *    - `timeout` Request Timeout in ms, after the delay if not resolved the promise will be rejected
     */
    delete(index: string, options?: ArgsIndexControllerDelete): Promise<void>;
    /**
     * Checks if the given index exists.
     *
     * @see https://docs.kuzzle.io/sdk/js/7/controllers/index/exists/
     *
     * @param index Index name
     * @param options Additional options
     *    - `queuable` If true, queues the request during downtime, until connected to Kuzzle again
     *    - `timeout` Request Timeout in ms, after the delay if not resolved the promise will be rejected
     */
    exists(index: string, options?: ArgsIndexControllerExists): Promise<boolean>;
    /**
     * Returns the complete list of indexes.
     *
     * @see https://docs.kuzzle.io/sdk/js/7/controllers/index/list/
     *
     * @param options Additional options
     *    - `queuable` If true, queues the request during downtime, until connected to Kuzzle again
     *    - `timeout` Request Timeout in ms, after the delay if not resolved the promise will be rejected
     */
    list(options?: ArgsIndexControllerList): Promise<Array<string>>;
    /**
     * Deletes multiple indexes
     *
     * @see https://docs.kuzzle.io/sdk/js/7/controllers/index/m-delete/
     *
     * @param indexes List of index names to delete
     * @param options Additional options
     *    - `queuable` If true, queues the request during downtime, until connected to Kuzzle again
     *    - `timeout` Request Timeout in ms, after the delay if not resolved the promise will be rejected
     *
     * @returns Names of successfully deleted indexes
     */
    mDelete(indexes: Array<string>, options?: ArgsIndexControllerMDelete): Promise<Array<string>>;
    /**
     * Returns detailed storage usage statistics.
     *
     * @see https://docs.kuzzle.io/sdk/js/7/controllers/index/stats/
     *
     * @param options Additional options
     *    - `queuable` If true, queues the request during downtime, until connected to Kuzzle again
     *    - `timeout` Request Timeout in ms, after the delay if not resolved the promise will be rejected
     */
    stats(options?: ArgsIndexControllerStats): Promise<JSONObject>;
}
export type ArgsIndexControllerCreate = ArgsDefault;
export type ArgsIndexControllerDelete = ArgsDefault;
export type ArgsIndexControllerExists = ArgsDefault;
export type ArgsIndexControllerList = ArgsDefault;
export type ArgsIndexControllerMDelete = ArgsDefault;
export type ArgsIndexControllerStats = ArgsDefault;