mirror of
https://github.com/flynx/test.js.git
synced 2025-10-28 10:20:09 +00:00
docs + notes...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
2c79a20759
commit
153167065a
42
README.md
42
README.md
@ -37,7 +37,8 @@ timeframe, use at your own risk, though ideas, feedback and suggestions are welc
|
|||||||
- [Components](#components)
|
- [Components](#components)
|
||||||
- [`DEFAULT_TEST_FILES`](#default_test_files)
|
- [`DEFAULT_TEST_FILES`](#default_test_files)
|
||||||
- [`IGNORE_TEST_FILES`](#ignore_test_files)
|
- [`IGNORE_TEST_FILES`](#ignore_test_files)
|
||||||
- [`Merged(..)`](#merged)
|
- [`Merged`](#merged)
|
||||||
|
- [`<merged>.create(..)`](#mergedcreate)
|
||||||
- [`<merged>.members`](#mergedmembers)
|
- [`<merged>.members`](#mergedmembers)
|
||||||
- [`<merged>.size` / `<merged>.usize`](#mergedsize--mergedusize)
|
- [`<merged>.size` / `<merged>.usize`](#mergedsize--mergedusize)
|
||||||
- [`<merged>.add(..)` / `<merged>.remove(..)`](#mergedadd--mergedremove)
|
- [`<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>.checkShadowing(..)`](#mergedcheckshadowing)
|
||||||
- [`<merged>.handleShadowing(..)`](#mergedhandleshadowing)
|
- [`<merged>.handleShadowing(..)`](#mergedhandleshadowing)
|
||||||
- [`<member>.filename`](#memberfilename)
|
- [`<member>.filename`](#memberfilename)
|
||||||
|
- [`TestSet`](#testset)
|
||||||
|
- [`BASE_TEST_SET`](#base_test_set)
|
||||||
- [`Setups(..)` / `Setup(..)` (Merged)](#setups--setup-merged)
|
- [`Setups(..)` / `Setup(..)` (Merged)](#setups--setup-merged)
|
||||||
- [`Modifiers(..)` / `Modifier(..)` (Merged)](#modifiers--modifier-merged)
|
- [`Modifiers(..)` / `Modifier(..)` (Merged)](#modifiers--modifier-merged)
|
||||||
- [`Tests(..)` / `Test(..)` (Merged)](#tests--test-merged)
|
- [`Tests(..)` / `Test(..)` (Merged)](#tests--test-merged)
|
||||||
@ -270,14 +273,22 @@ IGNORE_TEST_FILES =
|
|||||||
Default value: `['node_modules/**']`
|
Default value: `['node_modules/**']`
|
||||||
|
|
||||||
|
|
||||||
### `Merged(..)`
|
### `Merged`
|
||||||
|
|
||||||
Implements a _merged_ collection of instances (_members_).
|
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>
|
-> <member>
|
||||||
|
|
||||||
Merged(<key>, <func>)
|
<merged>(<key>, <func>)
|
||||||
-> <member>
|
-> <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(..)`,
|
(hence the name) attributes of the _members_ (i.e. `.keys(..)`, `.values(..)`,
|
||||||
`.entries(..)`, `.size`/`.usize` and `.members`).
|
`.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`
|
#### `<merged>.members`
|
||||||
|
|
||||||
@ -385,6 +409,16 @@ user to react to _shadowing_ in a different manner.
|
|||||||
The filename where the `<member>` was defined.
|
The filename where the `<member>` was defined.
|
||||||
|
|
||||||
|
|
||||||
|
### `TestSet`
|
||||||
|
|
||||||
|
XXX
|
||||||
|
|
||||||
|
|
||||||
|
### `BASE_TEST_SET`
|
||||||
|
|
||||||
|
XXX
|
||||||
|
|
||||||
|
|
||||||
### `Setups(..)` / `Setup(..)` (Merged)
|
### `Setups(..)` / `Setup(..)` (Merged)
|
||||||
|
|
||||||
XXX
|
XXX
|
||||||
|
|||||||
3
test.js
3
test.js
@ -257,6 +257,7 @@ var mergeIter = function(iter){
|
|||||||
//
|
//
|
||||||
// Merged is the sum of all its members.
|
// Merged is the sum of all its members.
|
||||||
//
|
//
|
||||||
|
// XXX is this generic enough to be moved to ig-types???
|
||||||
var Merged =
|
var Merged =
|
||||||
module.Merged =
|
module.Merged =
|
||||||
object.Constructor('Merged', {
|
object.Constructor('Merged', {
|
||||||
@ -328,8 +329,6 @@ object.Constructor('Merged', {
|
|||||||
|
|
||||||
create: function(name){
|
create: function(name){
|
||||||
return object.Constructor(name || this.name, this, {}) },
|
return object.Constructor(name || this.name, this, {}) },
|
||||||
//clone: function(){
|
|
||||||
//},
|
|
||||||
}, {
|
}, {
|
||||||
filename: undefined,
|
filename: undefined,
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user