IDocumentCollection Interface

Summary

Contains a collection of documents output by each pipeline. The documents are populated for each pipeline as it is executed and will contain the most recent set of document outputs for the most recently executed module, even if the pipeline is not complete.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.Documents
Interfaces
graph BT Type-.->Interface0["IEnumerable<IDocument>"] Type["IDocumentCollection"] class Type type-node

Syntax

public interface IDocumentCollection : IEnumerable<IDocument>

Properties

Name Value Summary
this[string] IEnumerable<IDocument>
Gets documents from a specific pipeline.

Methods

Name Value Summary
ByPipeline() IReadOnlyDictionary<string, IEnumerable<IDocument>>
Gets documents by pipeline.
ExceptPipeline(string) IEnumerable<IDocument>
Gets all documents output by every pipeline except those from the specified pipeline.
FromPipeline(string) IEnumerable<IDocument>
Gets documents from a specific pipeline.
GitHub