Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vitaly-t committed Mar 3, 2020
1 parent 862d790 commit e8f7f2e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/event.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export enum EmitSchedule {
* Data broadcast is fully asynchronous: each subscriber will be receiving the event
* within its own processor tick (under Node.js), or timer tick (in browsers).
*/
async = 'async',
async = 'async',

/**
* Wait for the next processor tick (under Node.js), or timer tick (in browsers),
Expand Down Expand Up @@ -396,6 +396,9 @@ export class SubEvent<T = unknown> {
* Creates a new subscription as a promise, to resolve with the next received value,
* and cancel the subscription. It can only reject when option `timeout` is specified.
*
* Note that if you use this method in a loop, it can miss events, as the subscription
* is cancelled after receiving the first event.
*
* @param options
* Subscription options:
*
Expand Down

0 comments on commit e8f7f2e

Please sign in to comment.