Interface PipelineResult<T>`Beta`

Result of running a pipeline. One per document (or per group with aggregation, or single for global aggregation).

interface PipelineResult<T = DocumentData> {
    createTime?: Timestamp;
    id?: string;
    ref?: DocumentReference<DocumentData, DocumentData>;
    updateTime?: Timestamp;
    data(): T;
    get(fieldPath: string | FieldPath | Field): unknown;
}

Type Parameters

T = DocumentData

Index

Methods

Properties

createTime? id? ref? updateTime?

Methods

data

data(): T
Beta
Returns T
- Defined in pipelines/pipeline-result.ts:28

get

get(fieldPath: string | FieldPath | Field): unknown
Beta
Parameters
- fieldPath: string | FieldPath | Field
Returns unknown
- Defined in pipelines/pipeline-result.ts:29

Properties

`Optional` `Readonly` `Beta`createTime

createTime?: Timestamp

`Optional` `Readonly` `Beta`id

id?: string

`Optional` `Readonly` `Beta`ref

ref?: DocumentReference<DocumentData, DocumentData>

`Optional` `Readonly` `Beta`updateTime

updateTime?: Timestamp