ig-types 6.15.1 → 6.15.6

package/Array.js

@@ -24,6 +24,9 @@ var STOP =
 module.STOP =
 	object.STOP
 
+var stoppable =
+module.stoppable =
+	generator.stoppable
 
 
 //---------------------------------------------------------------------
@@ -212,6 +215,7 @@ object.Mixin('ArrayMixin', 'soft', {
 			// done...
 			: [] },
 
+	// XXX add handler function support -- a-la generator.js'
 	iter: function*(lst=[]){
 		yield* lst.iter() },
 })
@@ -488,8 +492,22 @@ object.Mixin('ArrayProtoMixin', 'soft', {
 	//		-> iterator
 	//
 	// XXX should this take an argument and be like map??
-	iter: function*(){
-		yield* this },
+	// XXX this should handle throwing STOP!!!
+	// 		...might also ne a good idea to isolate the STOP mechanics 
+	// 		into a spearate module/package...
+	iter: stoppable(function*(handler=undefined){
+		if(handler){
+			var i = 0
+			for(var e of this){
+				var res = handler.call(this, e, i++) 
+				// treat non-iterables as single elements...
+				if(typeof(res) == 'object' 
+						&& Symbol.iterator in res){
+					yield* res
+				} else {
+					yield res } } 
+		} else {
+			yield* this }}),
 
 
 	// Stoppable iteration...

package/Promise.js

@@ -30,6 +30,8 @@
 
 var object = require('ig-object')
 
+//var generator = require('./generator')
+
 
 
 //---------------------------------------------------------------------
@@ -58,6 +60,7 @@ var object = require('ig-object')
 // 		
 // XXX how do we handle errors/rejections???
 // 		...mostly the current state is OK, but need more testing...
+// XXX add support for async generators...
 // 		
 
 var iterPromiseProxy = 
@@ -117,6 +120,11 @@ object.Constructor('IterablePromise', Promise, {
 	// 		stop will stop the handlers not yet run and not the next 
 	// 		handlers in sequence.
 	// 		XXX EXPEREMENTAL: STOP...
+	// XXX add support for async generators...
+	// 		...an async generator is not "parallel", i.e. intil one 
+	// 		returned promise is resolved the generator blocks (will not 
+	// 		advance)...
+	// 		...can we feed out a results one by one???
 	__pack: function(list, handler=undefined){
 		var that = this
 		// handle iterable promise list...
@@ -198,20 +206,6 @@ object.Constructor('IterablePromise', Promise, {
 					: handler(elem) }) },
 		//*/
 	// transform/handle packed array (sync)...
-	//
-	// XXX BUG:
-	// 			await Promise.iter(['a', Promise.resolve(222), ['c']])
-	// 					.map(async e => e)
-	// 				-> ['a', <promise>, ['c']]
-	// 		is not the same as:
-	// 			await Promise.iter(['a', Promise.resolve(222), ['c']])
-	// 					.map(e => e)
-	// 				-> ['a', 222, ['c']]
-	// 		...and these works as expected:
-	// 			await Promise.iter(['a', Promise.resolve(222), ['c']], async e => [e])
-	// 				-> ['a', 222, ['c']]
-	// 			await Promise.iter(['a', Promise.resolve(222), ['c']], e => [e])
-	// 				-> ['a', 222, ['c']]
 	__handle: function(list, handler=undefined){
 		var that = this
 		if(typeof(list) == 'function'){
@@ -300,6 +294,8 @@ object.Constructor('IterablePromise', Promise, {
 			.then(function(){ 
 				return res }) },
 
+	// XXX .chain(..) -- see generator.chain(..)
+
 	flat: function(depth=1){
 		return this.constructor(this, 
 			function(e){ 

package/README.md

@@ -94,7 +94,7 @@ Library of JavaScript type extensions, types and utilities.
       - [`generator.iter(..)`](#generatoriter)
       - [`generator.STOP`](#generatorstop)
     - [Generator instance iteration](#generator-instance-iteration)
-      - [`<generator>.iter()`](#generatoriter-1)
+      - [`<generator>.iter(..)`](#generatoriter-1)
       - [`<generator>.map(..)` / `<generator>.filter(..)`](#generatormap--generatorfilter)
       - [`<generator>.reduce(..)` / `<generator>.greduce(..)`](#generatorreduce--generatorgreduce)
       - [`<generator>.slice(..)`](#generatorslice)
@@ -102,7 +102,6 @@ Library of JavaScript type extensions, types and utilities.
       - [`<generator>.flat(..)`](#generatorflat)
       - [`<generator>.shift()` / `<generator>.pop()` / `<generator>.gshift()` / `<generator>.gpop()`](#generatorshift--generatorpop--generatorgshift--generatorgpop)
       - [`<generator>.unshift(..)` / `<generator>.push(..)`](#generatorunshift--generatorpush)
-      - [`<generator>.promise()`](#generatorpromise)
       - [`<generator>.then(..)` / `<generator>.catch(..)` / `<generator>.finally(..)`](#generatorthen--generatorcatch--generatorfinally)
       - [`<generator>.toArray()`](#generatortoarray)
     - [Treating iterators the same as generators](#treating-iterators-the-same-as-generators)
@@ -124,6 +123,15 @@ Library of JavaScript type extensions, types and utilities.
       - [`generator.produce(..)`](#generatorproduce)
     - [Generator helpers](#generator-helpers)
       - [`generator.stoppable(..)`](#generatorstoppable)
+  - [Async generator extensions](#async-generator-extensions)
+      - [`generator.AsyncGenerator`](#generatorasyncgenerator)
+      - [`<async-generator>.then(..)` / `<async-generator>.catch(..)` / `<async-generator>.finally(..)`](#async-generatorthen--async-generatorcatch--async-generatorfinally)
+      - [`<async-generator>.iter(..)`](#async-generatoriter)
+      - [`<async-generator>.map(..)` / `<async-generator>.filter(..)` / `<async-generator>.reduce(..)`](#async-generatormap--async-generatorfilter--async-generatorreduce)
+      - [`<async-generator>.chain(..)`](#async-generatorchain)
+      - [`<async-generator>.flat(..)`](#async-generatorflat)
+      - [`<async-generator>.concat(..)`](#async-generatorconcat)
+      - [`<async-generator>.push(..)` / `<async-generator>.unshift(..)`](#async-generatorpush--async-generatorunshift)
   - [Containers](#containers)
     - [`containers.UniqueKeyMap()` (`Map`)](#containersuniquekeymap-map)
       - [`<unique-key-map>.set(..)`](#unique-key-mapset)
@@ -2023,7 +2031,7 @@ Chained generators handle items depth-first, i.e. the items are passed as they
 are yielded down the generator chain.
 
 
-#### `<generator>.iter()`
+#### `<generator>.iter(..)`
 
 Iterate over the generator.
 ```bnf
@@ -2031,7 +2039,24 @@ Iterate over the generator.
     -> <generator>
 ```
 
-This is here mainly for compatibility with [`<array>`'s `.iter()`](#arrayiter--arrayiter).
+XXX move this to `generator.iter(..)`
+
+Compatible with [`<array>`'s `.iter()`](#arrayiter--arrayiter).
+
+`.iter(..)` also supports a handler function
+```bnf
+<generator>.iter(<handler>)
+    -> <generator>
+
+
+<handler>(<elem>, <index>)
+    -> <elem>
+    -> [<elem>, ..]
+    -> []
+```
+
+Note that the iterables returned by `<handler>(..)` will be expanded, to prevent 
+this wrap them in an array.
 
 
 #### `<generator>.map(..)` / `<generator>.filter(..)` 
@@ -2156,30 +2181,29 @@ Value added by `.unshift(..)` will be yielded by `<generator>` "first", i.e. on
 _next_ call to `.next()`, regardless of the current generator state.
 
 
-#### `<generator>.promise()`
+#### `<generator>.then(..)` / `<generator>.catch(..)` / `<generator>.finally(..)`
+
+Return a promise and resolve it with the generator value.
 
 ```bnf
-<generator>.promise()
+<generator>.then()
     -> <promise>
 ```
-Return a promise and resolve it with the generator value.
-
-Note that this will deplete the generator.
-
 
-#### `<generator>.then(..)` / `<generator>.catch(..)` / `<generator>.finally(..)`
+Adding handlers to the promise
 
 ```bnf
 <generator>.then(<resolve>, <reject>)
     -> <promise>
 
-<generator>.then(<reject>)
+<generator>.then(<resolve>)
     -> <promise>
 
 <generator>.finally(<handler>)
     -> <promise>
 ```
-Shorthands to `<generator>.promise().then(..)` / `<generator>.promise().catch(..)` / `<generator>.promise().finally(..)`
+
+Note that this will deplete the generator.
 
 These are the same as equivalent `Promise` methods, for more info see:  
 https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
@@ -2483,6 +2507,26 @@ stoppable(<generator>)
 
 <!-- XXX example? -->
 
+## Async generator extensions
+
+XXX EXPERIMENTAL
+
+#### `generator.AsyncGenerator`
+
+#### `<async-generator>.then(..)` / `<async-generator>.catch(..)` / `<async-generator>.finally(..)`
+
+#### `<async-generator>.iter(..)`
+
+#### `<async-generator>.map(..)` / `<async-generator>.filter(..)` / `<async-generator>.reduce(..)`
+
+#### `<async-generator>.chain(..)`
+
+#### `<async-generator>.flat(..)`
+
+#### `<async-generator>.concat(..)`
+
+#### `<async-generator>.push(..)` / `<async-generator>.unshift(..)`
+
 
 
 ## Containers

package/generator.js

@@ -86,13 +86,86 @@ var ITERATOR_PROTOTYPES = [
 
 //---------------------------------------------------------------------
 
+// XXX should this be part of object???
+var stoppable = 
+module.stoppable =
+function(func){
+	return Object.assign(
+		func instanceof Generator ?
+			// NOTE: the only difference between Generator/AsyncGenerator 
+			// 		versions of this is the async keyword -- keep them 
+			// 		in sync...
+			function*(){
+				try{
+					yield* func.call(this, ...arguments)
+				} catch(err){
+					if(err === STOP){
+						return
+					} else if(err instanceof STOP){
+						yield err.value
+						return }
+					throw err } }
+		: func instanceof AsyncGenerator ?
+			// NOTE: the only difference between Generator/AsyncGenerator 
+			// 		versions of this is the async keyword -- keep them 
+			// 		in sync...
+			async function*(){
+				try{
+					yield* func.call(this, ...arguments)
+				} catch(err){
+					if(err === STOP){
+						return
+					} else if(err instanceof STOP){
+						yield err.value
+						return }
+					throw err } }
+		: function(){
+			try{
+				return func.call(this, ...arguments)
+			} catch(err){
+				if(err === STOP){
+					return
+				} else if(err instanceof STOP){
+					return err.value }
+				throw err } },
+		{ toString: function(){
+			return func.toString() }, }) }
+
+
+//---------------------------------------------------------------------
 // generic generator wrapper...
+
+// helper...
+var __iter = 
+module.__iter =
+function*(lst=[]){
+	if(typeof(lst) == 'object' 
+			&& Symbol.iterator in lst){
+		yield* lst 
+	} else {
+		yield lst } }
+
+// XXX updatae Array.js' version for compatibility...
+// XXX DOCS!!!
 var iter = 
 module.iter = 
 Generator.iter =
-	function*(lst=[]){
-		for(var e of lst){
-			yield e } }
+	stoppable(function(lst=[]){
+		// handler -> generator-constructor...
+		if(typeof(lst) == 'function'){
+			// we need to be callable...
+			var that = this instanceof Function ?
+				this
+				// generic root generator...
+				: module.__iter
+			return function*(){
+				yield* that(...arguments).iter(lst) } }
+		// no handler -> generator instance...
+		return module.__iter(lst) })
+
+// NOTE: we need .iter(..) to both return generators if passed an iterable
+// 		and genereator constructos if passed a function...
+iter.__proto__ = GeneratorPrototype
 
 
 
@@ -121,9 +194,11 @@ Generator.iter =
 
 //
 // 	makeGenerator(<name>)
+// 	makeGenerator(<name>, <handler>)
 // 		-> <func>
 //
-// 	makeGenerator(<name>, <handler>)
+// 	makeGenerator('async', <name>)
+// 	makeGenerator('async', <name>, <handler>)
 // 		-> <func>
 //
 //
@@ -140,14 +215,26 @@ Generator.iter =
 // XXX this needs to be of the correct type... (???)
 // XXX need to accept generators as handlers...
 var makeGenerator = function(name, pre){
+	var sync = true
+	if(name == 'async'){
+		sync = false
+		var [name, pre] = [...arguments].slice(1) }
 	return function(...args){
 		var that = this
 		return Object.assign(
-			function*(){
-				var a = pre ? 
-					pre.call(this, args, ...arguments)
-					: args
-				yield* that(...arguments)[name](...a) }, 
+			// NOTE: the two branches here are identical, the only 
+			// 		difference is the async keyword...
+			sync ?
+				function*(){
+					var a = pre ? 
+						pre.call(this, args, ...arguments)
+						: args
+					yield* that(...arguments)[name](...a) }
+				: async function*(){
+					var a = pre ? 
+						pre.call(this, args, ...arguments)
+						: args
+					yield* that(...arguments)[name](...a) }, 
 			{ toString: function(){
 				return [
 					that.toString(), 
@@ -163,34 +250,6 @@ var makePromise = function(name){
 			return that(...arguments)[name](func) } } }
 
 
-var stoppable = 
-module.stoppable =
-function(func){
-	return Object.assign(
-		func instanceof Generator ?
-			function*(){
-				try{
-					yield* func.call(this, ...arguments)
-				} catch(err){
-					if(err === STOP){
-						return
-					} else if(err instanceof STOP){
-						yield err.value
-						return }
-					throw err } }
-			: function(){
-				try{
-					return func.call(this, ...arguments)
-				} catch(err){
-					if(err === STOP){
-						return
-					} else if(err instanceof STOP){
-						return err.value }
-					throw err } },
-		{ toString: function(){
-			return func.toString() }, }) }
-
-
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 
 var GeneratorMixin =
@@ -198,9 +257,7 @@ module.GeneratorMixin =
 object.Mixin('GeneratorMixin', 'soft', {
 	STOP: object.STOP,
 
-	// NOTE: this is here for compatibility with Array.iter(..)
-	iter: function*(lst=[]){
-		yield* module.iter(lst) },
+	iter: module.iter,
 
 	gat: makeGenerator('gat'),
 	at: function(i){
@@ -272,15 +329,31 @@ object.Mixin('GeneratorMixin', 'soft', {
 						e(...args)
 						: e }) }),
 	//zip: makeGenerator('zip'),
+	
+	enumerate: makeGenerator('enumerate'),
 })
 
 
 var GeneratorProtoMixin =
 module.GeneratorProtoMixin =
 object.Mixin('GeneratorProtoMixin', 'soft', {
-	// NOTE: this is here for compatibility with [..].iter()
-	iter: function*(){ 
-		yield* this },
+	// XXX use module.iter(..) ???
+	iter: stoppable(function*(handler){ 
+		if(handler){
+			var i = 0
+			for(var elem of this){
+				var res = handler.call(this, elem, i) 
+				// expand iterables...
+				if(typeof(res) == 'object' 
+						&& Symbol.iterator in res){
+					yield* res
+				// as-is...
+				} else {
+					yield res }}
+		// no handler...
+		} else {
+			yield* this } }),
+	//*/
 
 	at: function(i){
 		return this.gat(i).next().value },
@@ -390,17 +463,19 @@ object.Mixin('GeneratorProtoMixin', 'soft', {
 
 	// promises...
 	//
-	// XXX how do we handle reject(..) / .catch(..)???
-	promise: function(){
+	then: function(onresolve, onreject){
 		var that = this
-		return new Promise(function(resolve){
-				resolve([...that]) }) },
-	then: function(func){
-		return this.promise().then(func) },
+		var p = new Promise(
+			function(resolve){
+				resolve([...that]) }) 
+		p = (onresolve || onreject) ?
+			p.then(...arguments)
+			: p
+		return p },
 	catch: function(func){
-		return this.promise().catch(func) },
+		return this.then().catch(func) },
 	finally: function(func){
-		return this.promise().finally(func) },
+		return this.then().finally(func) },
 
 	// combinators...
 	//
@@ -423,6 +498,11 @@ object.Mixin('GeneratorProtoMixin', 'soft', {
 		// XXX
 	},
 	//*/
+
+	enumerate: function*(){
+		var i = 0
+		for(var e of this){
+			yield [i++, e] } },
 })
 
 
@@ -439,36 +519,102 @@ ITERATOR_PROTOTYPES
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 // XXX EXPERIMENTAL...
 
-var makeAsyncGenerator = function(name, pre){
-	return function(...args){
-		var that = this
-		return Object.assign(
-			async function*(){
-				var a = pre ? 
-					pre.call(this, args, ...arguments)
-					: args
-				for await (var e of that(...arguments)[name](...a)){
-					yield e } }, 
-			{ toString: function(){
-				return [
-					that.toString(), 
-					// XXX need to normalize args better...
-					`.${ name }(${ args.join(', ') })`,
-				].join('\n    ') }, }) } }
-
 var AsyncGeneratorMixin =
 module.AsyncGeneratorMixin =
 object.Mixin('AsyncGeneratorMixin', 'soft', {
-	map: makeAsyncGenerator('map'),
+	// XXX TEST...
+	iter: makeGenerator('async', 'iter'),
+
+	map: makeGenerator('async', 'map'),
+	filter: makeGenerator('async', 'filter'),
+	reduce: makeGenerator('async', 'reduce'),
 })
 
 var AsyncGeneratorProtoMixin =
 module.AsyncGeneratorProtoMixin =
 object.Mixin('AsyncGeneratorProtoMixin', 'soft', {
+	// promise...
+	//
+	// NOTE: this will unwind the generator...
+	// XXX create an iterator promise???
+	// XXX should we unwind???
+	then: function(resolve, reject){
+		var that = this
+		var p = new Promise(async function(_resolve, _reject){
+			var res = []
+			for await(var elem of that){
+				res.push(elem) }
+			_resolve(res) }) 
+		p = (resolve || reject) ?
+			p.then(...arguments)
+			: p
+		return p },
+	catch: function(func){
+		return this.then().catch(func) },
+	finally: function(){
+		return this.then().finally(func) },
+
+	// XXX might be a good idea to use this approach above...
+	iter: stoppable(async function*(handler=undefined){
+		var i = 0
+		if(handler){
+			for await(var e of this){
+				var res = handler.call(this, e, i++)
+				if(typeof(res) == 'object' 
+						&& Symbol.iterator in res){
+					yield* res
+				} else {
+					yield res } }
+		} else {
+			yield* this } }),
+
+	map: async function*(func){
+		yield* this.iter(function(elem, i){
+			return [func.call(this, elem, i)] }) },
+	filter: async function*(func){
+		yield* this.iter(function(elem, i){
+			return func.call(this, elem, i) ?
+	   			[elem]
+				: [] }) },
+	// NOTE: there is not much point in .reduceRight(..) in an async 
+	// 		generator as we'll need to fully unwind it then go from the 
+	// 		end...
+	reduce: async function(func, state){
+		this.iter(function(elem, i){
+			state = func.call(this, state, elem, i) 
+			return [] })
+		return state },
+
+	// XXX TEST...
+	chain: async function*(...next){
+		yield* next
+			.reduce(function(cur, next){
+				return next(cur) }, this) },
+
+	flat: async function*(){
+		for await(var e of this){
+			if(e instanceof Array){
+				yield* e
+			} else {
+				yield e }}},
+
+	concat: async function*(other){
+		yield* this
+		yield* other },
+	push: async function*(elem){
+		yield* this
+		yield elem },
+	unsift: async function*(elem){
+		yield elem 
+		yield* this },
+
+	// XXX
+	// 	slice -- not sure if we need this...
+	// 	...
 })
 
-//AsyncGeneratorMixin(AsyncGeneratorPrototype)
-//AsyncGeneratorProtoMixin(AsyncGeneratorPrototype.prototype)
+AsyncGeneratorMixin(AsyncGeneratorPrototype)
+AsyncGeneratorProtoMixin(AsyncGeneratorPrototype.prototype)
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ig-types",
-  "version": "6.15.1",
+  "version": "6.15.6",
   "description": "Generic JavaScript types and type extensions...",
   "main": "main.js",
   "scripts": {