scvo-router/dist/router.d.ts

Pipes to open Elasticsearch to everything we do

import { SearchResponse } from 'elasticsearch';
import { IContext, IRouteResponse } from './interfaces';
/** Class for managing incoming requests, routing them to Elasticsearch queries, and rendering output */
export declare class Router {
    private context;
    private uaId;
    private uaUid;
    private uaDebug;
    private routeRecognizer;
    private defaultResult;
    private _visitor;
    private readonly visitor;
    /**
     * Create a Router for matching routes and rendering responses
     * @param {IRoutes} routes The routes and their configurations we are matching against
     */
    constructor(context: IContext, uaId?: string, uaUid?: string, uaDebug?: boolean);
    generateUrl(routeName: string, params: any): any;
    /**
     * Execute the route against a URI to get a matched route and rendered responses
     * @param {string} uriString - The URI to be matched
     * @return {RouteMatch} The matched route with rendered results
     */
    execute(uriString: string): Promise<IRouteResponse>;
    trackRoute(path: string): void;
    trackDocumentHit(results: SearchResponse<any>): void;
}