Represents the results of a Firestore pipeline execution.

A `PipelineSnapshot` contains zero or more [PipelineResult](https://firebase.google.com/docs/reference/js/firestore_lite_pipelines.pipelineresult#pipelineresult_class) objects representing the documents returned by a pipeline query. It provides methods to iterate over the documents and access metadata about the query results.

**Signature:**

    export declare class PipelineSnapshot 

## Constructors

| Constructor | Modifiers | Description |
|---|---|---|
| [(constructor)(pipeline, results, executionTime)](https://firebase.google.com/docs/reference/js/firestore_pipelines.pipelinesnapshot#pipelinesnapshotconstructor) |   | Constructs a new instance of the `PipelineSnapshot` class |

## Properties

| Property | Modifiers | Type | Description |
|---|---|---|---|
| [executionTime](https://firebase.google.com/docs/reference/js/firestore_pipelines.pipelinesnapshot#pipelinesnapshotexecutiontime) |   | [Timestamp](https://firebase.google.com/docs/reference/js/firestore.timestamp#timestamp_class) | The time at which the pipeline producing this result is executed. |
| [results](https://firebase.google.com/docs/reference/js/firestore_pipelines.pipelinesnapshot#pipelinesnapshotresults) |   | [PipelineResult](https://firebase.google.com/docs/reference/js/firestore_pipelines.pipelineresult#pipelineresult_class)\[\] | An array of all the results in the `PipelineSnapshot`. |

## PipelineSnapshot.(constructor)

Constructs a new instance of the `PipelineSnapshot` class

**Signature:**

    constructor(
        pipeline: Pipeline,
        results: PipelineResult[],
        executionTime?: Timestamp
      );

#### Parameters

| Parameter | Type | Description |
|---|---|---|
| pipeline | [Pipeline](https://firebase.google.com/docs/reference/js/firestore_pipelines.pipeline#pipeline_class) |   |
| results | [PipelineResult](https://firebase.google.com/docs/reference/js/firestore_pipelines.pipelineresult#pipelineresult_class)\[\] |   |
| executionTime | [Timestamp](https://firebase.google.com/docs/reference/js/firestore.timestamp#timestamp_class) |   |

## PipelineSnapshot.executionTime

The time at which the pipeline producing this result is executed.

**Signature:**

    get executionTime(): Timestamp;

## PipelineSnapshot.results

An array of all the results in the `PipelineSnapshot`.

**Signature:**

    get results(): PipelineResult[];

### Example

    const snapshot: PipelineSnapshot = await firestore
      .pipeline()
      .collection('myCollection')
      .where(field('value').greaterThan(10))
      .execute();

    snapshot.results.forEach(doc => {
      console.log(doc.id, '=>', doc.data());
    });