mirror of
https://github.com/flynx/object.js.git
synced 2025-10-29 02:20:08 +00:00
docs...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
ee05101695
commit
a30c562660
34
object.js
34
object.js
@ -390,7 +390,39 @@ BOOTSTRAP(function(){
|
||||
})
|
||||
|
||||
|
||||
// XXX
|
||||
// Wrap a callable in a STOP handler
|
||||
//
|
||||
// stoppable(func)
|
||||
// -> func
|
||||
//
|
||||
// stoppable(gen)
|
||||
// -> gen
|
||||
//
|
||||
// stoppable(asyncgen)
|
||||
// -> asyncgen
|
||||
//
|
||||
//
|
||||
// The client callable can be one of:
|
||||
// - function
|
||||
// - generator
|
||||
// - async generator
|
||||
//
|
||||
// The returned callable will be of the same type as the input callable.
|
||||
//
|
||||
// The wrapper handles STOP slightly differently if the client is a
|
||||
// function or if it is a generator / async generator:
|
||||
// - function
|
||||
// STOP returned / thrown
|
||||
// -> return undefined
|
||||
// STOP(value) returned / thrown
|
||||
// -> return value
|
||||
// - generator / async generator
|
||||
// STOP yielded / thrown
|
||||
// -> iteration stops
|
||||
// STOP(value) yielded / thrown
|
||||
// -> value yielded and iteration stops
|
||||
//
|
||||
// XXX should we use this for sources(..) and friends...
|
||||
var stoppable =
|
||||
module.stoppable =
|
||||
function(func){
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user