Skip to content

Commit 24aeec7

Browse files
committed
Update README with AsyncOption documentation
1 parent 3cbee91 commit 24aeec7

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,8 @@ The `AsyncOption[T]` type is the asynchronous version of `Option`. It allows you
496496
compose asynchronous operations that may return an optional value, using the Option type.
497497
This is particularly useful for handling optional values in asynchronous code, such as
498498
API calls that might not return a value, database queries that might not find a record,
499-
or any other I/O-bound tasks that might not produce a meaningful result.
499+
or any other I/O-bound tasks that might not produce a meaningful result. The AsyncOption
500+
builder was added in version 0.25.0.
500501

501502
Similar to the `Option` effect, AsyncOption enables short-circuiting but for asynchronous
502503
operations. If any part of the function yields `Nothing`, the function is short-circuited

README.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,8 @@ async def outer() -> AsyncGenerator[int, int]:
546546
compose asynchronous operations that may return an optional value, using the Option type.
547547
This is particularly useful for handling optional values in asynchronous code, such as
548548
API calls that might not return a value, database queries that might not find a record,
549-
or any other I/O-bound tasks that might not produce a meaningful result.
549+
or any other I/O-bound tasks that might not produce a meaningful result. The AsyncOption
550+
builder was added in version 0.25.0.
550551
551552
Similar to the `Option` effect, AsyncOption enables short-circuiting but for asynchronous
552553
operations. If any part of the function yields `Nothing`, the function is short-circuited

0 commit comments

Comments
 (0)