# arqeo

> A npm package to organize and validate artifacts

Latest version **0.3.0** (published 2023-03-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install arqeo
pnpm add arqeo
yarn add arqeo
bun add arqeo
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2023-03-08 |
| First published | 2023-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | brunolnetto |
| Maintainers | brunolnetto |
| Keywords | array, condition |

## Links

- npm: https://www.npmjs.com/package/arqeo
- Repository: https://github.com/trouchet/arqeo
- Homepage: https://github.com/trouchet/arqeo#readme
- Issues: https://github.com/trouchet/arqeo/issues
- npm.io page: https://npm.io/package/arqeo

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21

## Recent versions

- 0.3.0 (latest) — 2023-03-08
- 0.2.7 — 2023-03-08
- 0.2.6 — 2023-03-08
- 0.2.5 — 2023-02-22
- 0.2.4 — 2023-02-21
- 0.2.3 — 2023-02-18
- 0.2.2 — 2023-02-18
- 0.2.1 — 2023-02-18
- 0.2.0 — 2023-02-18
- 0.1.1 — 2023-02-14
- 0.1.0 — 2023-02-11
- 0.0.5 — 2023-02-11
- 0.0.4 — 2023-02-10
- 0.0.3 — 2023-02-10
- 0.0.2 — 2023-02-10

## README

![investigate yourself](https://raw.githubusercontent.com/trouchet/arqeo/main/images/arqeo_small.png)
# Arqeo
[![Version](https://img.shields.io/npm/v/arqeo.svg)](https://www.npmjs.com/package/arqeo)
[![codecov](https://codecov.io/gh/trouchet/arqeo/branch/main/graph/badge.svg?token=55H8MVEJQJ)](https://codecov.io/gh/trouchet/arqeo)
[![downloads](https://img.shields.io/npm/dm/arqeo)](https://www.npmjs.com/package/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

---
_Source: https://npm.io/package/arqeo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
