Clause

var ArrayClause = C.cat('foos', C.oneOrMore(C.equal('foo')),
                    'bars', C.oneOrMore(C.equal('bar')));

C.conform(ArrayClause, ['foo', 'foo', 'foo', 'bar', 'bar']);
// returns { foos: ['foo', 'foo', 'foo'], bars: ['bar', 'bar'] };

var StrClause = C.cat('foos', C.oneOrMore(C.sEqual('foo')),
                    'bars', C.oneOrMore(C.sEqual('bar')));

C.conform(StrClause, 'foofoofoobarbar');
// returns { foos: 'foofoofoo', bars: 'barbarbar' };

Notice that in the first clause, we use C.equals() to treat the string as a single entity, whereas in the second, we use C.sEqual() to suggest that each character in the string is part of a collection that we run regex ops on.

API

Work in progress.

Below is a set of auto-generated API reference by clausejs-docgen based on clause declarations and their corrosponding annotations.

C()

function

Registers or retrieves a clause from global clause regitry by path.

Synopsis

<register>:
<retrieve>:

Argument clause

or (alts)

Should be one of the following:

Option 1 <register> : Put the given expression onto the given path in the global clause registry.
cat (concatenation) of

Should be an ordered list of the following:
1. 1st <nsPath>
  
  of predicate
  A value that satisfies isNamespacePath()
2. 2nd <expression>
  
  of clause
  A value that is of clausejs.types/Expression
Option 2 <retrieve> : Retrieves an expression from the given namespace path, or returns null if not found.
cat (concatenation) of

Should be an ordered list of the following:
1. 1st <nsPath>
  
  of predicate
  A value that satisfies isNamespacePath()

clausejs.compose/

cat()

function

Synopsis

AND

Argument clause

and

Should satisfy all of the following expression:

Part 1
cat (concatenation) of

Should be an ordered list of the following:
1. 1st <expressions>
  
  or (alts)
  
  Should be one of the following:
  
  Option 1 <withLabels>
  
  or (alts)
  
  Should be one of the following:
  
  Option 1
  
  zero or more of (*)
  
  cat (concatenation) of
  
  Should be an ordered list of the following:
  
  1st <name>
  
  of predicate
  A value that satisfies isClauseName()
  
  2nd <comment>
  
  optional (?)
  
  of predicate
  A value that satisfies isString()
  
  TODO
  
  3rd <expr>
  
  of clause
  A value that is of clausejs.types/Expression
  
  TODO
  
  Option 2
  
  collection of
  
  cat (concatenation) of
  
  Should be an ordered list of the following:
  
  1st <name>
  
  of predicate
  A value that satisfies isClauseName()
  
  2nd <comment>
  
  optional (?)
  
  of predicate
  A value that satisfies isString()
  
  TODO
  
  3rd <expr>
  
  of clause
  A value that is of clausejs.types/Expression
  
  TODO
  
  Option 2 <withoutLabels>
  
  zero or more of (*)
  
  of clause
  A value that is of clausejs.types/Expression
  
  TODO
2. 2nd <options>
  
  optional (?)
  
  and
  
  Should satisfy all of the following expression:
  
  Part 1
  
  of predicate
  A value that satisfies isObject()
  
  Part 2
  
  of predicate
  A value that satisfies not_isExpr()
  
  TODO
Part 2

of predicate
A value that satisfies noDupelicateLabels()

Return value clause

of predicate

A value that satisfies isClause()

or()

function

Synopsis

AND

Argument clause

and

Should satisfy all of the following expression:

Part 1
cat (concatenation) of

Should be an ordered list of the following:
1. 1st <expressions>
  
  or (alts)
  
  Should be one of the following:
  
  Option 1 <withLabels>
  
  or (alts)
  
  Should be one of the following:
  
  Option 1
  
  zero or more of (*)
  
  cat (concatenation) of
  
  Should be an ordered list of the following:
  
  1st <name>
  
  of predicate
  A value that satisfies isClauseName()
  
  2nd <comment>
  
  optional (?)
  
  of predicate
  A value that satisfies isString()
  
  TODO
  
  3rd <expr>
  
  of clause
  A value that is of clausejs.types/Expression
  
  TODO
  
  Option 2
  
  collection of
  
  cat (concatenation) of
  
  Should be an ordered list of the following:
  
  1st <name>
  
  of predicate
  A value that satisfies isClauseName()
  
  2nd <comment>
  
  optional (?)
  
  of predicate
  A value that satisfies isString()
  
  TODO
  
  3rd <expr>
  
  of clause
  A value that is of clausejs.types/Expression
  
  TODO
  
  Option 2 <withoutLabels>
  
  zero or more of (*)
  
  of clause
  A value that is of clausejs.types/Expression
  
  TODO
2. 2nd <options>
  
  optional (?)
  
  and
  
  Should satisfy all of the following expression:
  
  Part 1
  
  of predicate
  A value that satisfies isObject()
  
  Part 2
  
  of predicate
  A value that satisfies not_isExpr()
  
  TODO
Part 2

of predicate
A value that satisfies noDupelicateLabels()

Return value clause

of predicate

A value that satisfies isClause()

zeroOrMore()

function

Synopsis

zeroOrMore(expr, opts)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <expr>

of clause
A value that is of clausejs.types/Expression
2nd <opts>

optional (?)

of predicate
A value that satisfies isObject()

TODO

Return value clause

of predicate

A value that satisfies isClause()

oneOrMore()

function

Synopsis

oneOrMore(expr, opts)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <expr>

of clause
A value that is of clausejs.types/Expression
2nd <opts>

optional (?)

of predicate
A value that satisfies isObject()

TODO

Return value clause

of predicate

A value that satisfies isClause()

zeroOrOne()

function

Synopsis

zeroOrOne(expr, opts)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <expr>

of clause
A value that is of clausejs.types/Expression
2nd <opts>

optional (?)

of predicate
A value that satisfies isObject()

TODO

Return value clause

of predicate

A value that satisfies isClause()

and()

function

Synopsis: O_OR_M
Argument clause: one or more of (+)

of clause
A value that is of clausejs.types/Expression

TODO
Return value clause: of predicate
A value that satisfies isClause()

collOf()

function

Synopsis

collOf(expr, opts)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <expr>

of clause
A value that is of clausejs.types/Expression
2nd <opts>

optional (?)

of predicate
A value that satisfies isObject()

TODO

Return value clause

of predicate

A value that satisfies isClause()

mapOf()

function

Synopsis

mapOf(keyExpression, valExpression)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <keyExpression>

of clause
A value that is of clausejs.types/Expression
2nd <valExpression>

of clause
A value that is of clausejs.types/Expression

Return value clause

of predicate

A value that satisfies isClause()

shape()

function

Synopsis

shape(shapeArgs)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <shapeArgs>

shape
TODO

Return value clause

of predicate

A value that satisfies isClause()

any()

function

Return value clause: of clause
A value that is of clausejs.types/Clause

wall()

function

Synopsis

wall(Expression)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st

of clause
A value that is of clausejs.types/Expression

Return value clause

of clause

A value that is of clausejs.types/Expression

fclause()

function

Synopsis

fclause(fclauseFields)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <fclauseFields>

shape
TODO

nullable()

function

Synopsis

nullable(Expression)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st

of clause
A value that is of clausejs.types/Expression

undefinable()

function

Synopsis

undefinable(Expression)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st

of clause
A value that is of clausejs.types/Expression

clausejs.utils/

enforce()

function

Synopsis

enforce(expression, valueToCheck)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <expression>

of clause
A value that is of clausejs.types/Expression
2nd <valueToCheck>

any
Any value.

Return value clause

of predicate

A value that satisfies isUndefined()

conform()

function

Synopsis

conform(expression, valueToConform)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <expression>

of clause
A value that is of clausejs.types/Expression
2nd <valueToConform>

any
Any value.

Return value clause

or (alts)

Should be one of the following:

Option 1 <conformedValue>

any
Any value.
Option 2 <problem>

of predicate
A value that is of clausejs.types/Problem

delayed()

function

Synopsis

delayed(getFn)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <getFn>

of fclause (function)

Return value clause

of clause
A value that is of clausejs.types/Expression

Return value clause

of clause

A value that is of clausejs.types/DelayedClause

C.describe()

function

Returns an abbreviated description of the clause as a simple tree structure.

Synopsis

C.describe()

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st

or (alts)
A value that is of clausejs.types/Expression

Return value clause

of predicate

A value that satisfies isString()

clausejs.preds/

not()

function

Synopsis

not(predicateToNegate)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <predicateToNegate>

of predicate
A value that is of clausejs.types/Predicate

Return value clause

of fclause (function)

Synopsis

(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isObj()

function

Synopsis

isObj(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isStr()

function

Synopsis

isStr(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isArray()

function

Synopsis

isArray(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isDate()

function

Synopsis

isDate(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isNull()

function

Synopsis

isNull(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isUndefined()

function

Synopsis

isUndefined(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

notEmpty()

function

Synopsis

notEmpty(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isBool()

function

Synopsis

isBool(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isFn()

function

Synopsis

isFn(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isNum()

function

Synopsis

isNum(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isInt()

function

Synopsis

isInt(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isNatInt()

function

Synopsis

isNatInt(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

isUuid()

function

Synopsis

isUuid(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

oneOf()

function

Synopsis

oneOf(valueOptions)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <valueOptions>

collection of

or (alts)
A value that is of clausejs.types/Primitive

TODO

Return value clause

of fclause (function)

Synopsis

(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

equals()

function

Synopsis

equals(valueToCompareWith)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <valueToCompareWith>

any
Any value.

Return value clause

of fclause (function)

Synopsis

(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

instanceOf()

function

Synopsis

instanceOf(instanceType)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <instanceType>

of predicate
A value that satisfies isFunction()

Return value clause

of fclause (function)

Synopsis

(x)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <x>

any
Any value.

Return value clause

of predicate

A value that satisfies isBool()

clausejs.namespace/

set()

function

Synopsis

set(nsPath, expression)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <nsPath>

of predicate
A value that satisfies isNamespacePath()
2nd <expression>

of clause
A value that is of clausejs.types/Expression

Return value clause

of predicate

A value that satisfies isUndefined()

get()

function

Synopsis

get(nsPath)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <nsPath>

of predicate
A value that satisfies isNamespacePath()

Return value clause

of clause

A value that is of clausejs.types/Expression

meta()

function

Synopsis

meta(source, metaObj)

Argument clause

cat (concatenation) of

Should be an ordered list of the following:

1st <source>
or (alts)

Should be one of the following:
1. Option 1 <namespacePath>
  
  of predicate
  A value that satisfies isNamespacePath()
2. Option 2 <expression>
  
  of predicate
  A value that satisfies isExpr()
2nd <metaObj>

of predicate
A value that satisfies isObject()

Return value clause

of predicate

A value that satisfies isExpr()

clausejs.types/

Expression

Should be one of the following:

Option 1 <clause>

of clause
A value that is of clausejs.types/Clause
Option 2 <pred>

of clause
A value that is of clausejs.types/Predicate
Option 3 <delayedClause>

of clause
A value that is of clausejs.types/DelayedClause
Option 4 <clauseRef>

of clause
A value that is of clausejs.types/ClauseReference

Clause

predicate

A value that satisfies isClause()

FClause

and

Should satisfy all of the following expression:

Part 1

of predicate
A value that satisfies isFclause()

Predicate

predicate

A value that satisfies isPred()

DelayedClause

predicate

A value that satisfies isDelayedClause()

ClauseReference

predicate

A value that satisfies isClauseRef()

Problem

predicate

A value that satisfies isProblem()

NamespaceObj

shape

TODO

NamespacePath

predicate

A value that satisfies isNamespacePath()

Primitive

Should be one of the following:

Option 1

of predicate
A value that satisfies isString()
Option 2

of predicate
A value that satisfies isNum()
Option 3

of predicate
A value that satisfies isBool()
Option 4

of predicate
A value that satisfies isNull()
Option 5

of predicate
A value that satisfies isUndefined()