Skip to content

Commit

Permalink
Release 0.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
pjeby committed May 21, 2024
1 parent 03e29bf commit c8cf703
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "uneventful",
"version": "0.0.3",
"version": "0.0.4",
"description": "Declarative, event-driven reactivity: signals, streams, structured concurrency, and easy resource cleanup",
"keywords": [
"signals",
Expand Down
2 changes: 1 addition & 1 deletion src/async.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Request, Yielding } from "./types.ts";
import { rejecter, resolve, resolver } from "./results.ts"

/**
* Convert a promise to something you can `yield *to()` in a job
* Convert a (possible) promise to something you can `yield *to()` in a job
*
* Much like `await valueOrPromiseLike` in an async function, using `yield
* *to(valueOrPromiseLike)` in a {@link Job}'s generator function will return
Expand Down
2 changes: 1 addition & 1 deletion src/signals.ts
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ export function peek<F extends PlainFunction>(fn: F, ...args: Parameters<F>): Re
* on every call to recalcWhen().
*
* If the source needs to reference some object, it's best to use the 2-argument
* version (i.e. `changesWhen(someObj, factory)`, where `factory` is a function
* version (i.e. `recalcWhen(someObj, factory)`, where `factory` is a function
* that takes `someObj` and returns a suitable {@link RecalcSource}.)
*
* @remarks
Expand Down
12 changes: 6 additions & 6 deletions src/sinks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -163,18 +163,18 @@ function waitTruthy<T>(job: Job<T>, v: T) { v && job.return(v); }
* processed with `yield *` within a {@link Job}).
*
* This differs from {@link until}() in that it waits for the *next* value
* (truthy or not!), and it never resumes immediately for signals, but instead waits
* for the signal to *change*. (Also, it does not support zero-argument functions,
* unless you wrap them with {@link cached}() first.)
* (truthy or not!), and it never resumes immediately for signals, but instead
* waits for the signal to *change*. (Also, it does not support zero-argument
* functions, unless you wrap them with {@link cached}() first.)
*
* @param source The source to wait on, which can be:
* - An object with an `"uneventful.next"` method returning a {@link Yielding}
* (in which case the result will be the the result of calling that method)
* - A {@link Signal} or {@link Source} (in which case the job resumes on the
* next value it produces)
* next value it produces)
*
* (Note: if the supplied source has a non-zero `.length`, it is assumed to be a
* {@link Source}.)
* (Note: if the supplied source is a function with a non-zero `.length`, it is
* assumed to be a {@link Source}.)
*
* @returns a Yieldable that when processed with `yield *` in a job, will return
* the triggered event, or signal value. An error is thrown if event stream
Expand Down
2 changes: 1 addition & 1 deletion src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ export interface Job<T=any> extends Yielding<T>, Promise<T> {
* In order to ensure that all such "child" jobs, resources, and activities
* are marked as canceled *before* any side effects (such as events,
* callbacks or I/O operations) can occur, Uneventful prioritizes *all*
* release callbacks to run before *any* other callbacks of any kind. since
* release callbacks to run before *any* other callbacks of any kind. Since
* release callbacks are used for child jobs, this means that the entire job
* subtree is notified immediately of cancellation, before any other actions
* are taken. This ensures that no "stray" operations can continue, unaware
Expand Down

0 comments on commit c8cf703

Please sign in to comment.