Skip to content

Commit 32c7a47

Browse files
abelbraaksmaabelbraaksma
committed
Update documentation with the new TaskSeq<_> 
1 parent d902f4d commit 32c7a47

File tree

1 file changed

+87
-87
lines changed

1 file changed

+87
-87
lines changed

‎README.md

+87-87
Original file line numberDiff line numberDiff line change
@@ -463,93 +463,93 @@ The following are the current surface area of the `TaskSeq` utility functions, o
463463

464464
```f#
465465
module TaskSeq =
466-
val append: source1: taskSeq<'T> -> source2: taskSeq<'T> -> taskSeq<'T>
467-
val appendSeq: source1: taskSeq<'T> -> source2: seq<'T> -> taskSeq<'T>
468-
val box: source: taskSeq<'T> -> taskSeq<obj>
469-
val cast: source: taskSeq<obj> -> taskSeq<'T>
470-
val choose: chooser: ('T -> 'U option) -> source: taskSeq<'T> -> taskSeq<'U>
471-
val chooseAsync: chooser: ('T -> #Task<'U option>) -> source: taskSeq<'T> -> taskSeq<'U>
472-
val collect: binder: ('T -> #taskSeq<'U>) -> source: taskSeq<'T> -> taskSeq<'U>
473-
val collectAsync: binder: ('T -> #Task<'TSeqU>) -> source: taskSeq<'T> -> taskSeq<'U> when 'TSeqU :> taskSeq<'U>
474-
val collectSeq: binder: ('T -> #seq<'U>) -> source: taskSeq<'T> -> taskSeq<'U>
475-
val collectSeqAsync: binder: ('T -> #Task<'SeqU>) -> source: taskSeq<'T> -> taskSeq<'U> when 'SeqU :> seq<'U>
476-
val concat: sources: taskSeq<#taskSeq<'T>> -> taskSeq<'T>
477-
val contains<'T when 'T: equality> : value: 'T -> source: taskSeq<'T> -> Task<bool>
478-
val delay: generator: (unit -> taskSeq<'T>) -> taskSeq<'T>
479-
val empty<'T> : taskSeq<'T>
480-
val exactlyOne: source: taskSeq<'T> -> Task<'T>
481-
val except<'T when 'T: equality> : itemsToExclude: taskSeq<'T> -> source: taskSeq<'T> -> taskSeq<'T>
482-
val exceptOfSeq<'T when 'T: equality> : itemsToExclude: seq<'T> -> source: taskSeq<'T> -> taskSeq<'T>
483-
val exists: predicate: ('T -> bool) -> source: taskSeq<'T> -> Task<bool>
484-
val existsAsync: predicate: ('T -> #Task<bool>) -> source: taskSeq<'T> -> Task<bool>
485-
val filter: predicate: ('T -> bool) -> source: taskSeq<'T> -> taskSeq<'T>
486-
val filterAsync: predicate: ('T -> #Task<bool>) -> source: taskSeq<'T> -> taskSeq<'T>
487-
val find: predicate: ('T -> bool) -> source: taskSeq<'T> -> Task<'T>
488-
val findAsync: predicate: ('T -> #Task<bool>) -> source: taskSeq<'T> -> Task<'T>
489-
val findIndex: predicate: ('T -> bool) -> source: taskSeq<'T> -> Task<int>
490-
val findIndexAsync: predicate: ('T -> #Task<bool>) -> source: taskSeq<'T> -> Task<int>
491-
val fold: folder: ('State -> 'T -> 'State) -> state: 'State -> source: taskSeq<'T> -> Task<'State>
492-
val foldAsync: folder: ('State -> 'T -> #Task<'State>) -> state: 'State -> source: taskSeq<'T> -> Task<'State>
493-
val head: source: taskSeq<'T> -> Task<'T>
494-
val indexed: source: taskSeq<'T> -> taskSeq<int * 'T>
495-
val init: count: int -> initializer: (int -> 'T) -> taskSeq<'T>
496-
val initAsync: count: int -> initializer: (int -> #Task<'T>) -> taskSeq<'T>
497-
val initInfinite: initializer: (int -> 'T) -> taskSeq<'T>
498-
val initInfiniteAsync: initializer: (int -> #Task<'T>) -> taskSeq<'T>
499-
val isEmpty: source: taskSeq<'T> -> Task<bool>
500-
val item: index: int -> source: taskSeq<'T> -> Task<'T>
501-
val iter: action: ('T -> unit) -> source: taskSeq<'T> -> Task<unit>
502-
val iterAsync: action: ('T -> #Task<unit>) -> source: taskSeq<'T> -> Task<unit>
503-
val iteri: action: (int -> 'T -> unit) -> source: taskSeq<'T> -> Task<unit>
504-
val iteriAsync: action: (int -> 'T -> #Task<unit>) -> source: taskSeq<'T> -> Task<unit>
505-
val last: source: taskSeq<'T> -> Task<'T>
506-
val length: source: taskSeq<'T> -> Task<int>
507-
val lengthBy: predicate: ('T -> bool) -> source: taskSeq<'T> -> Task<int>
508-
val lengthByAsync: predicate: ('T -> #Task<bool>) -> source: taskSeq<'T> -> Task<int>
509-
val lengthOrMax: max: int -> source: taskSeq<'T> -> Task<int>
510-
val map: mapper: ('T -> 'U) -> source: taskSeq<'T> -> taskSeq<'U>
511-
val mapAsync: mapper: ('T -> #Task<'U>) -> source: taskSeq<'T> -> taskSeq<'U>
512-
val mapi: mapper: (int -> 'T -> 'U) -> source: taskSeq<'T> -> taskSeq<'U>
513-
val mapiAsync: mapper: (int -> 'T -> #Task<'U>) -> source: taskSeq<'T> -> taskSeq<'U>
514-
val ofArray: source: 'T[] -> taskSeq<'T>
515-
val ofAsyncArray: source: Async<'T> array -> taskSeq<'T>
516-
val ofAsyncList: source: Async<'T> list -> taskSeq<'T>
517-
val ofAsyncSeq: source: seq<Async<'T>> -> taskSeq<'T>
518-
val ofList: source: 'T list -> taskSeq<'T>
519-
val ofResizeArray: source: ResizeArray<'T> -> taskSeq<'T>
520-
val ofSeq: source: seq<'T> -> taskSeq<'T>
521-
val ofTaskArray: source: #Task<'T> array -> taskSeq<'T>
522-
val ofTaskList: source: #Task<'T> list -> taskSeq<'T>
523-
val ofTaskSeq: source: seq<#Task<'T>> -> taskSeq<'T>
524-
val pick: chooser: ('T -> 'U option) -> source: taskSeq<'T> -> Task<'U>
525-
val pickAsync: chooser: ('T -> #Task<'U option>) -> source: taskSeq<'T> -> Task<'U>
526-
val prependSeq: source1: seq<'T> -> source2: taskSeq<'T> -> taskSeq<'T>
527-
val singleton: source: 'T -> taskSeq<'T>
528-
val tail: source: taskSeq<'T> -> Task<taskSeq<'T>>
529-
val takeWhile: predicate: ('T -> bool) -> source: taskSeq<'T> -> Task<taskSeq<'T>>
530-
val takeWhileAsync: predicate: ('T -> #Task<bool>) -> source: taskSeq<'T> -> Task<taskSeq<'T>>
531-
val takeWhileInclusive: predicate: ('T -> bool) -> source: taskSeq<'T> -> Task<taskSeq<'T>>
532-
val takeWhileInclusiveAsync: predicate: ('T -> #Task<bool>) -> source: taskSeq<'T> -> Task<taskSeq<'T>>
533-
val toArray: source: taskSeq<'T> -> 'T[]
534-
val toArrayAsync: source: taskSeq<'T> -> Task<'T[]>
535-
val toIListAsync: source: taskSeq<'T> -> Task<IList<'T>>
536-
val toList: source: taskSeq<'T> -> 'T list
537-
val toListAsync: source: taskSeq<'T> -> Task<'T list>
538-
val toResizeArrayAsync: source: taskSeq<'T> -> Task<ResizeArray<'T>>
539-
val toSeq: source: taskSeq<'T> -> seq<'T>
540-
val tryExactlyOne: source: taskSeq<'T> -> Task<'T option>
541-
val tryFind: predicate: ('T -> bool) -> source: taskSeq<'T> -> Task<'T option>
542-
val tryFindAsync: predicate: ('T -> #Task<bool>) -> source: taskSeq<'T> -> Task<'T option>
543-
val tryFindIndex: predicate: ('T -> bool) -> source: taskSeq<'T> -> Task<int option>
544-
val tryFindIndexAsync: predicate: ('T -> #Task<bool>) -> source: taskSeq<'T> -> Task<int option>
545-
val tryHead: source: taskSeq<'T> -> Task<'T option>
546-
val tryItem: index: int -> source: taskSeq<'T> -> Task<'T option>
547-
val tryLast: source: taskSeq<'T> -> Task<'T option>
548-
val tryPick: chooser: ('T -> 'U option) -> source: taskSeq<'T> -> Task<'U option>
549-
val tryPickAsync: chooser: ('T -> #Task<'U option>) -> source: taskSeq<'T> -> Task<'U option>
550-
val tryTail: source: taskSeq<'T> -> Task<taskSeq<'T> option>
551-
val unbox<'U when 'U: struct> : source: taskSeq<obj> -> taskSeq<'U>
552-
val zip: source1: taskSeq<'T> -> source2: taskSeq<'U> -> taskSeq<'T * 'U>
466+
val append: source1: TaskSeq<'T> -> source2: TaskSeq<'T> -> TaskSeq<'T>
467+
val appendSeq: source1: TaskSeq<'T> -> source2: seq<'T> -> TaskSeq<'T>
468+
val box: source: TaskSeq<'T> -> TaskSeq<obj>
469+
val cast: source: TaskSeq<obj> -> TaskSeq<'T>
470+
val choose: chooser: ('T -> 'U option) -> source: TaskSeq<'T> -> TaskSeq<'U>
471+
val chooseAsync: chooser: ('T -> #Task<'U option>) -> source: TaskSeq<'T> -> TaskSeq<'U>
472+
val collect: binder: ('T -> #TaskSeq<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
473+
val collectAsync: binder: ('T -> #Task<'TSeqU>) -> source: TaskSeq<'T> -> TaskSeq<'U> when 'TSeqU :> TaskSeq<'U>
474+
val collectSeq: binder: ('T -> #seq<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
475+
val collectSeqAsync: binder: ('T -> #Task<'SeqU>) -> source: TaskSeq<'T> -> TaskSeq<'U> when 'SeqU :> seq<'U>
476+
val concat: sources: TaskSeq<#TaskSeq<'T>> -> TaskSeq<'T>
477+
val contains<'T when 'T: equality> : value: 'T -> source: TaskSeq<'T> -> Task<bool>
478+
val delay: generator: (unit -> TaskSeq<'T>) -> TaskSeq<'T>
479+
val empty<'T> : TaskSeq<'T>
480+
val exactlyOne: source: TaskSeq<'T> -> Task<'T>
481+
val except<'T when 'T: equality> : itemsToExclude: TaskSeq<'T> -> source: TaskSeq<'T> -> TaskSeq<'T>
482+
val exceptOfSeq<'T when 'T: equality> : itemsToExclude: seq<'T> -> source: TaskSeq<'T> -> TaskSeq<'T>
483+
val exists: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<bool>
484+
val existsAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<bool>
485+
val filter: predicate: ('T -> bool) -> source: TaskSeq<'T> -> TaskSeq<'T>
486+
val filterAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> TaskSeq<'T>
487+
val find: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<'T>
488+
val findAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<'T>
489+
val findIndex: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<int>
490+
val findIndexAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<int>
491+
val fold: folder: ('State -> 'T -> 'State) -> state: 'State -> source: TaskSeq<'T> -> Task<'State>
492+
val foldAsync: folder: ('State -> 'T -> #Task<'State>) -> state: 'State -> source: TaskSeq<'T> -> Task<'State>
493+
val head: source: TaskSeq<'T> -> Task<'T>
494+
val indexed: source: TaskSeq<'T> -> TaskSeq<int * 'T>
495+
val init: count: int -> initializer: (int -> 'T) -> TaskSeq<'T>
496+
val initAsync: count: int -> initializer: (int -> #Task<'T>) -> TaskSeq<'T>
497+
val initInfinite: initializer: (int -> 'T) -> TaskSeq<'T>
498+
val initInfiniteAsync: initializer: (int -> #Task<'T>) -> TaskSeq<'T>
499+
val isEmpty: source: TaskSeq<'T> -> Task<bool>
500+
val item: index: int -> source: TaskSeq<'T> -> Task<'T>
501+
val iter: action: ('T -> unit) -> source: TaskSeq<'T> -> Task<unit>
502+
val iterAsync: action: ('T -> #Task<unit>) -> source: TaskSeq<'T> -> Task<unit>
503+
val iteri: action: (int -> 'T -> unit) -> source: TaskSeq<'T> -> Task<unit>
504+
val iteriAsync: action: (int -> 'T -> #Task<unit>) -> source: TaskSeq<'T> -> Task<unit>
505+
val last: source: TaskSeq<'T> -> Task<'T>
506+
val length: source: TaskSeq<'T> -> Task<int>
507+
val lengthBy: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<int>
508+
val lengthByAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<int>
509+
val lengthOrMax: max: int -> source: TaskSeq<'T> -> Task<int>
510+
val map: mapper: ('T -> 'U) -> source: TaskSeq<'T> -> TaskSeq<'U>
511+
val mapAsync: mapper: ('T -> #Task<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
512+
val mapi: mapper: (int -> 'T -> 'U) -> source: TaskSeq<'T> -> TaskSeq<'U>
513+
val mapiAsync: mapper: (int -> 'T -> #Task<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
514+
val ofArray: source: 'T[] -> TaskSeq<'T>
515+
val ofAsyncArray: source: Async<'T> array -> TaskSeq<'T>
516+
val ofAsyncList: source: Async<'T> list -> TaskSeq<'T>
517+
val ofAsyncSeq: source: seq<Async<'T>> -> TaskSeq<'T>
518+
val ofList: source: 'T list -> TaskSeq<'T>
519+
val ofResizeArray: source: ResizeArray<'T> -> TaskSeq<'T>
520+
val ofSeq: source: seq<'T> -> TaskSeq<'T>
521+
val ofTaskArray: source: #Task<'T> array -> TaskSeq<'T>
522+
val ofTaskList: source: #Task<'T> list -> TaskSeq<'T>
523+
val ofTaskSeq: source: seq<#Task<'T>> -> TaskSeq<'T>
524+
val pick: chooser: ('T -> 'U option) -> source: TaskSeq<'T> -> Task<'U>
525+
val pickAsync: chooser: ('T -> #Task<'U option>) -> source: TaskSeq<'T> -> Task<'U>
526+
val prependSeq: source1: seq<'T> -> source2: TaskSeq<'T> -> TaskSeq<'T>
527+
val singleton: source: 'T -> TaskSeq<'T>
528+
val tail: source: TaskSeq<'T> -> Task<TaskSeq<'T>>
529+
val takeWhile: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<TaskSeq<'T>>
530+
val takeWhileAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<TaskSeq<'T>>
531+
val takeWhileInclusive: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<TaskSeq<'T>>
532+
val takeWhileInclusiveAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<TaskSeq<'T>>
533+
val toArray: source: TaskSeq<'T> -> 'T[]
534+
val toArrayAsync: source: TaskSeq<'T> -> Task<'T[]>
535+
val toIListAsync: source: TaskSeq<'T> -> Task<IList<'T>>
536+
val toList: source: TaskSeq<'T> -> 'T list
537+
val toListAsync: source: TaskSeq<'T> -> Task<'T list>
538+
val toResizeArrayAsync: source: TaskSeq<'T> -> Task<ResizeArray<'T>>
539+
val toSeq: source: TaskSeq<'T> -> seq<'T>
540+
val tryExactlyOne: source: TaskSeq<'T> -> Task<'T option>
541+
val tryFind: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<'T option>
542+
val tryFindAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<'T option>
543+
val tryFindIndex: predicate: ('T -> bool) -> source: TaskSeq<'T> -> Task<int option>
544+
val tryFindIndexAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> Task<int option>
545+
val tryHead: source: TaskSeq<'T> -> Task<'T option>
546+
val tryItem: index: int -> source: TaskSeq<'T> -> Task<'T option>
547+
val tryLast: source: TaskSeq<'T> -> Task<'T option>
548+
val tryPick: chooser: ('T -> 'U option) -> source: TaskSeq<'T> -> Task<'U option>
549+
val tryPickAsync: chooser: ('T -> #Task<'U option>) -> source: TaskSeq<'T> -> Task<'U option>
550+
val tryTail: source: TaskSeq<'T> -> Task<TaskSeq<'T> option>
551+
val unbox<'U when 'U: struct> : source: TaskSeq<obj> -> TaskSeq<'U>
552+
val zip: source1: TaskSeq<'T> -> source2: TaskSeq<'U> -> TaskSeq<'T * 'U>
553553
```
554554

555555
[buildstatus]: https://github.com/fsprojects/FSharp.Control.TaskSeq/actions/workflows/main.yaml

0 commit comments

Comments
 (0)