docs + notes...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2020-10-13 04:30:49 +03:00
parent 2c79a20759
commit 153167065a
2 changed files with 39 additions and 6 deletions

View File

@ -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)
- [`<merged>.create(..)`](#mergedcreate)
- [`<merged>.members`](#mergedmembers)
- [`<merged>.size` / `<merged>.usize`](#mergedsize--mergedusize)
- [`<merged>.add(..)` / `<merged>.remove(..)`](#mergedadd--mergedremove)
@ -47,6 +48,8 @@ timeframe, use at your own risk, though ideas, feedback and suggestions are welc
- [`<merged>.checkShadowing(..)`](#mergedcheckshadowing)
- [`<merged>.handleShadowing(..)`](#mergedhandleshadowing)
- [`<member>.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({ <key>: <func>, .. })
Merged.create(<name>)
-> <merged>
```
Add members to collection:
```
<merged>({ <key>: <func>, .. })
-> <member>
Merged(<key>, <func>)
<merged>(<key>, <func>)
-> <member>
```
@ -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.
#### `<merged>.create(..)`
Create a new `Merged` collection (member constructor).
```
Merged.create(<name>)
-> <merged>
```
#### `<merged>.members`
@ -385,6 +409,16 @@ user to react to _shadowing_ in a different manner.
The filename where the `<member>` was defined.
### `TestSet`
XXX
### `BASE_TEST_SET`
XXX
### `Setups(..)` / `Setup(..)` (Merged)
XXX

View File

@ -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,