Type Definitions
DatumPlan_Dsl
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
VALUE |
Indicator of a "tip" of the Lens branch to construct; equivalent to value exported by this module |
|
NAMED_VALUES |
May be used as an Object spec to indicate a dictionary-type object in the structure or called with the datum plan spec of the entries to indicate a dictionary-type having entries with specified structure; either kind of use may be mixed into an Object spec with other explicit own-properties via spread syntax |
|
RAW |
Allows specifying otherwise special property names; its value should be an object whose properties will spec lenses in the Object where RAW appears |
DatumPlan_DslCallback(DSL)
- Source:
A callback Function of this kind can be passed to datumPlan in order to use active JavaScript in defining the datum plan specification or for use of the named values and Functions passed in the DSL parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
DSL |
DatumPlan_Dsl | Helpful values and Functions for creating a datum plan specification |
Returns:
A datum plan specification
DatumPlan_Tweak(plan) → {Object|Array}
- Source:
- Since:
- 2.1.0
Parameters:
| Name | Type | Description |
|---|---|---|
plan |
Object | Array | The plan to be modified |
Returns:
Altered clone of plan
- Type
- Object | Array
DatumPlan_TweaksBuilderCallback(DSL) → {Array.<DatumPlan_Tweak>}
- Source:
- Since:
- 2.1.0
Parameters:
| Name | Type | Description |
|---|---|---|
DSL |
DatumPlan_TweaksDsl | Helpful values and Functions for altering POD into a datum plan specification |
Returns:
- Type
- Array.<DatumPlan_Tweak>
DatumPlan_TweaksDsl
- Source:
- Since:
- 2.1.0
- Mixes In:
Properties:
| Name | Type | Description |
|---|---|---|
access |
DatumPlan_TweakBuilder | |
lens |
function | The default export of module:natural-lenses |
FallbackBindingResult
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
or |
function |
<optional> |
The function to return if the slot does not contain a function. |
Type:
- Object
FoundPair
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
0 |
* | Value of found item |
|
1 |
number | string |
<optional> |
Index or key of found item |
Type:
- Array
Maybe
- Source:
- See:
-
- Haskell's "Maybe" data type
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
just |
* |
<optional> |
The contained value |
The presence of just as a property indicates the "Just" construction of
the Maybe monad — the presence of a value (even if undefined). A Maybe
without a just property is the "Nothing" construction.
Type:
- Object
OptionalThrow
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
orThrow |
* |
<optional> |
The value to |
Type:
- Object