Encapsule Project

@encapsule/arccore v0.3.6-bigsnowlake

Encapsule Project Addressable Resource Cell (ARC) core algorithms runtime library package.

Package: @encapsule/arccore v0.3.6-bigsnowlake build d21KCDYhQ4OteRdl6AO9Gw
Sources: @encapsule/dpmr-arc-core-at#0f31e3fdb2c840b53e4aaf5378331f496a3c2b76
Purpose: library (Node.js + HTML5)
Created: 2022-05-12T04:50:51.000Z
License: MIT

@encapsule/arccore Package Distribution (npmjs)
@encapsule/arccore Package Repo (GitHub)
@encapsule/arccore Package Issues (GitHub)

Overview

ARCcore Runtime Documentation

The @encapsule/arccore package contains runtime algorithms for schematizing, filtering, routing, and modeling strongly-typed in-memory data with mathematical graphs and JSON-serializable data types for use in Node.js and HTML5 application services implemented in JavaScript.

Use

Add the @encapsule/arccore package to your Node.js project's package.json manifest:

1. Create simple test project, declare a dependency and install @encapsule/arccore package:

$ mkdir testProject && cd testProject
$ npm init --yes
$ npm install @encapsule/arccore --save-dev

2. Create a simple script index.js:

const arccore = require('@encapsule/arccore');
console.log(JSON.stringify(arccore.__meta));
/* ... your derived code here ... */

Runtime Libraries

The @encapsule/arrccore package is a pre-tested, minified, self-contained, distribution package containing runtime algorithms used to build Node.js and HTML5 infrastructure and advanced data-driven application services.

ARCcore.filter

ARCcore.filter Documentation

Build self-documenting functions with strong data type and value constraint enforcement provided automatically at runtime.

ARCcore.discriminator

ARCcore.discriminator Documentation

Register a set of ARCcore.filter intances to create a "discriminator" filter that "routes" calls to a specific filter in the set based on the shape of the request.

ARCcore.graph

ARCcore.graph Documentation

Directed graph container class and algorithms for modeling and analyzing directed graph datasets in memory.

ARCcore.identifier

ARCcore.identifier Documentation

Generate non-cryptographic object signatures and random keys in 6-character (32-bit) and 22-character (128-bit) Internet Routable Unique Token (IRUT) string format.

Note: The @encapsule/arccore.identifier runtime library leverages the uuid and murmurhash-js npm packages that are included this this package as bundled dependencies.

ARCcore.types

ARCcore.types Documentation

A collection of functions for testing and comparing the type of in-memory entities.

ARCcore.util

ARCcore.util Documentation

A collection of utility functions used primarily by other libraries contained in the arccore package.

Bundled Dependencies

The @encapsule/arccore package includes the minified source code for MIT-licensed packages murmurhash-js and uuid.

If your derived application/service requires either of these packages, use the same version bundled in the @encapsule/arccore package via __bundle export object:

const arccore = require("@encapsule/arccore");
const murmurhash_js = arccore.__bundle.murmurhash_js;
const uuid = arccore.__bundle.uuid;

Encapsule Project

Published under MIT license by Encapsule Project

Copyright © 2012-2022 Chris Russell

GitHub: https://github/encapsule

Twitter: https://twitter.com/encapsule