dataclasses - Documentation

Source:

dataclasses/index.js, line 3

Since:

1.0.0

Data classes

Methods

(static) Target(target) → {Target}

Source:

dataclasses/columns.js, line 19

Create a new target

Parameters:

Name	Type	Description
`target`	object
↳ `target_id`	string	unique id for this target
↳ `label`	string	label that will be displayed for this target
↳ `type_id`	string	the type_id name this target has

Returns:

dataclasses.Target

Type: Target

(static) Operator(operator) → {Operator}

Source:

dataclasses/columns.js, line 39

Create a new operator

Parameters:

Name	Type	Description
`operator`	object
↳ `operator_id`	string	unique id for this operator
↳ `label`	string	label that will be displayed for this operator

Returns:

dataclasses.Operator

Type: Operator

(static) Type(type) → {Type}

Source:

dataclasses/columns.js, line 66

Create a new type

Parameters:

Name	Type	Description
`type`	Object
↳ `type_id`	string
↳ `operator_ids`	Array.<string>

Returns:

dataclasses.Type

Type: Type

(static) LogicalType(logic)

Source:

dataclasses/columns.js, line 87

Create a new type logical type Logical types or used in CompoundPredicates

Parameters:

Name	Type	Description
`logic`	Object	The predicate logic
`type.logicalType_id`	string
`type.label`	string

(static) Predicate(type) → {dataclasses.Predicate}

Source:

dataclasses/predicates.js, line 17

Abstract Predicate type, a Predicate is the union type of CompoundPredicate | ComparisonPredicate

Parameters:

Name	Type	Description
`type`	function	Predicate subtype function constructor

Returns:

Type: dataclasses.Predicate

(static) ComparisonPredicate(target, operator, args) → {Promise.<dataclasses.ComparisonPredicate>}

Source:

dataclasses/predicates.js, line 54

A specialized predicate that you use to compare expressions.

Parameters:

Name	Type	Description
`target`	dataclasses.Target
`operator`	dataclasses.Operator
`args`	Array.<*>

Returns:

yield a ComparisonPredicate or a rejected promise

Type: Promise.<dataclasses.ComparisonPredicate>

(static) ComparisonPredicate.is(predicate) → {Boolean}

Source:

dataclasses/predicates.js, line 73

Yield true if `predicate` is a ComparisonPredicate

Parameters:

Name	Type	Description
`predicate`	dataclasses.Predicate	dataclasses.Predicate

Returns:

Type: Boolean

(static) CompoundPredicate(logic, predicates) → {Promise.<dataclasses.CompoundPredicate>}

Source:

dataclasses/predicates.js, line 86

A specialized predicate that evaluates logical combinations of other predicates.

Parameters:

Name	Type	Description
`logic`	dataclasses.LogicalType	The predicate logic
`predicates`	Array.<dataclasses.Predicate>	predicates

Returns:

yield a dataclasses.CompoundPredicate or a errors.CompoundPredicateMustHaveAtLeastOneSubPredicate rejected promise

Type: Promise.<dataclasses.CompoundPredicate>

(static) CompoundPredicate.reduce(compoundPredicate, f, acc, [parents]) → {T}

Source:

dataclasses/predicates.js, line 113

Reduce through the predicates tree

Parameters:

Name	Type	Attributes	Default	Description
`compoundPredicate`	dataclasses.CompoundPredicate			starter node
`f`	function			accumulation function, f(acc, predicate, parents)
`acc`	T			accumulator
`parents`	Array	optional	`[]`	path to the node, array of parents