Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Pipeline

Pipeline is a client for running query pipelines on a collection. See Pipeline.search for more details.

Create a new Pipeline via Client.pipeline.

// const client = new Client(...);
const pipeline = client.pipeline("website");

Hierarchy

  • Pipeline

Index

Methods

Methods

search

  • Search runs a search query defined by a pipeline with the given values and session configuration. The callback is executed with the query results and any values that have been modified/created by the pipeline. If an error occurs this will be passed to the callback as a RequestError.

    pipeline.search({ q: "<search query>" }, session, (error, results, values) => {
      if (error) {
        console.error(error);
        return;
      }
      console.log(results, values);
    });
    

    Parameters

    Returns void

Generated using TypeDoc