Arqeo

Concepts

This npm module aims to give a development tools for items condition-check. The behavior emulates, for example, Typescript type-check.

The object-concepts are:

1. Artifact: an item or array that fulfills certain boolean-condition;
2. Collection: An artifact or array of artifacts.

The callback-concepts are:

1. isArtifactCallback: 1-input/boolean-output function for respective artifact item or array;
2. applyCallback: 1-input/any-output function to apply on respective artifact item or array;

The main available functionalities are:

• Checkers:

  1. is: validates candidate with isArtifactCallback-function to verify it is an artifact;
  2. are: verifies if candidate with isArtifactCallback-function to verify it is a collection;
  3. has: verifies if candidate has valid artifact items;

• catalog: applies isArtifactCallback boolean callback on potential {artifact, collection}-elements to validate each item individually.

• apply: applies applyCallback-function on artifact-candidate with validation of isArtifactCallback boolean callback.

• pick: pick valid artifact items according to isArtifactCallback boolean callback.

Use cases

The interested reader may access use-cases described above on test files available on code folders below:

1. Artifacts: src/__test__/artifacts.test.js
2. Checkers: src/__test__/checkers.test.js
3. Curators: src/__test__/curators.test.js