Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions release-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Release notes:
1.0.0
- adds TaskSeq.withCancellation, #167
- adds docs/ with fsdocs-based documentation site covering generating, transforming, consuming, combining and advanced operations
- docs: adds missing XML <returns> documentation tags to singleton, isEmpty, length, lengthOrMax, lengthBy, and lengthByAsync

0.7.0
- performance: TaskSeq.exists, existsAsync, contains no longer allocate an intermediate Option value
Expand Down
6 changes: 6 additions & 0 deletions src/FSharp.Control.TaskSeq/TaskSeq.fsi
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ type TaskSeq =
/// </summary>
///
/// <param name="value">The input item to use as the single item of the task sequence.</param>
/// <returns>A task sequence containing exactly one element.</returns>
static member singleton: value: 'T -> TaskSeq<'T>

/// <summary>
Expand All @@ -119,6 +120,7 @@ type TaskSeq =
/// </summary>
///
/// <param name="source">The input task sequence.</param>
/// <returns>A task returning <c>true</c> if the sequence contains no elements; <c>false</c> otherwise.</returns>
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
static member isEmpty: source: TaskSeq<'T> -> Task<bool>

Expand All @@ -128,6 +130,7 @@ type TaskSeq =
/// </summary>
///
/// <param name="source">The input task sequence.</param>
/// <returns>A task returning the number of elements in the sequence.</returns>
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
static member length: source: TaskSeq<'T> -> Task<int>

Expand All @@ -139,6 +142,7 @@ type TaskSeq =
///
/// <param name="max">Limit at which to stop evaluating source items for finding the length.</param>
/// <param name="source">The input task sequence.</param>
/// <returns>A task returning the actual length of the sequence, or <paramref name="max" /> if the sequence is longer than <paramref name="max" />.</returns>
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
static member lengthOrMax: max: int -> source: TaskSeq<'T> -> Task<int>

Expand All @@ -150,6 +154,7 @@ type TaskSeq =
///
/// <param name="predicate">A function to test whether an item in the input sequence should be included in the count.</param>
/// <param name="source">The input task sequence.</param>
/// <returns>A task returning the number of elements for which <paramref name="predicate" /> returns <c>true</c>.</returns>
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
static member lengthBy: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<int>

Expand All @@ -161,6 +166,7 @@ type TaskSeq =
///
/// <param name="predicate">A function to test whether an item in the input sequence should be included in the count.</param>
/// <param name="source">The input task sequence.</param>
/// <returns>A task returning the number of elements for which <paramref name="predicate" /> returns <c>true</c>.</returns>
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
static member lengthByAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<int>

Expand Down
Loading