From 153167065a56b010f7f3a96e6ad492f37af31de2 Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Tue, 13 Oct 2020 04:30:49 +0300 Subject: [PATCH] docs + notes... Signed-off-by: Alex A. Naanou --- README.md | 42 ++++++++++++++++++++++++++++++++++++++---- test.js | 3 +-- 2 files changed, 39 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7b9700f..5340516 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,8 @@ timeframe, use at your own risk, though ideas, feedback and suggestions are welc - [Components](#components) - [`DEFAULT_TEST_FILES`](#default_test_files) - [`IGNORE_TEST_FILES`](#ignore_test_files) - - [`Merged(..)`](#merged) + - [`Merged`](#merged) + - [`.create(..)`](#mergedcreate) - [`.members`](#mergedmembers) - [`.size` / `.usize`](#mergedsize--mergedusize) - [`.add(..)` / `.remove(..)`](#mergedadd--mergedremove) @@ -47,6 +48,8 @@ timeframe, use at your own risk, though ideas, feedback and suggestions are welc - [`.checkShadowing(..)`](#mergedcheckshadowing) - [`.handleShadowing(..)`](#mergedhandleshadowing) - [`.filename`](#memberfilename) + - [`TestSet`](#testset) + - [`BASE_TEST_SET`](#base_test_set) - [`Setups(..)` / `Setup(..)` (Merged)](#setups--setup-merged) - [`Modifiers(..)` / `Modifier(..)` (Merged)](#modifiers--modifier-merged) - [`Tests(..)` / `Test(..)` (Merged)](#tests--test-merged) @@ -270,14 +273,22 @@ IGNORE_TEST_FILES = Default value: `['node_modules/**']` -### `Merged(..)` +### `Merged` Implements a _merged_ collection of instances (_members_). + +Create a new collection: ``` -Merged({ : , .. }) +Merged.create() + -> +``` + +Add members to collection: +``` +({ : , .. }) -> -Merged(, ) +(, ) -> ``` @@ -291,6 +302,19 @@ Provides a set of methods and properties to access/introspect the _merged_ (hence the name) attributes of the _members_ (i.e. `.keys(..)`, `.values(..)`, `.entries(..)`, `.size`/`.usize` and `.members`). +Note that though `Merged` itself is a collection, it is not designed to be used +directly as a collection, use it to create new collections or as a prototype for +inheritance. + + +#### `.create(..)` + +Create a new `Merged` collection (member constructor). +``` +Merged.create() + -> +``` + #### `.members` @@ -385,6 +409,16 @@ user to react to _shadowing_ in a different manner. The filename where the `` was defined. +### `TestSet` + +XXX + + +### `BASE_TEST_SET` + +XXX + + ### `Setups(..)` / `Setup(..)` (Merged) XXX diff --git a/test.js b/test.js index 5173c82..bcc3af3 100644 --- a/test.js +++ b/test.js @@ -257,6 +257,7 @@ var mergeIter = function(iter){ // // Merged is the sum of all its members. // +// XXX is this generic enough to be moved to ig-types??? var Merged = module.Merged = object.Constructor('Merged', { @@ -328,8 +329,6 @@ object.Constructor('Merged', { create: function(name){ return object.Constructor(name || this.name, this, {}) }, - //clone: function(){ - //}, }, { filename: undefined,