hcore v1.2.0

HCore

A TypeScript library providing data structures and utilities to be used across all apps.

Getting Started

Installation

Install with npm run install --save hcore.

Philosophy

Any code that is non-platform specific and provides an useful abstraction or utility likely belongs in this library. The benefit of this is two-fold. Firstly, it minimizes code duplication. More important, however, is the compounding reward of having a single highly maintained set of simple utilities instead of complex application specific ones.

Constants

Math Constants

• E
• PI
• SQRT_3
• SQRT_2

English Constants

• ALPHABET ('a', 'b', 'c',...)
• DIGITS ('1', '2', '3'...)
• SPECIAL_CHARACTERS (!, @, #...)
• AMBIGUOUS_CHARACTERS (characters such as 0 and O)

Data Structures

HashMap

HashMap<T> is a simple wrapper over an object with string keys and type T values.

Use generateHashMap<T>(data: T[], hashFn: (t: T) => string) to convert an array of data to an indexable object. This is good way to convert O(n^2) algorithms into O(n).

import {HashMap, generateHashMap} from 'hcore/dist/structures/hashMap'

const A = [
    { id: 'a', foo: 'foo' },
    { id: 'b', foo: 'bar' },
    { id: 'c', foo: ';)'  },
]

const B = [
    { id: 'b', foo: 'bar' },
    { id: 'c', foo: ';)'  },
    { id: 'd', foo: ':0'  },
]

// Find the intersection of two sets
function intersection(a, b) {
    
    const output = [];
    
    // For each item we could iterate the other array to see if it exists, but it won't scale well to larger problems. 
    // It's quicker to create a hashmap (or lookup table) first.

    // generate a hashmap with the ID as the key.
    const lookupTable = generateHashMap(a, (a) => a.id);

    for (const item of B) {
        if (lookupTable.hasOwnProperty(item.id)) {
            output.push(item);
        }
    }

    return output;
}

Utilities

Random

hcore/dist/random exposes the Random class which provides several static functions to generate random data.

// Here are some examples

Random.float(0, 10) // 5.321234
Random.int(0, 5) // 3
Random.digits(4) // "0023"
Random.alphanumeric(6) // "as3F9d"

Path

hcore/dist/path exposes the Path class which provides a method of rigidly defining and using dynamic string paths. The motivation for this comes from developing powerful frontend api service wrappers as quickly as possible while maintaining a clean codebase.

hcore/dist/pathParameters is a wrapper around the HashMap specifically designed for the Path class. This is exposed in Path.params.

const assetDir = new Path('assets/:subFolder?/:file', {subFolder: 'sprites'})

assetDir.path // Error! file must be defined
assetDir.params.setParam('file', 'ntf.png')
assetDir.path // "assets/sprites/ntf.png"
assetDir.params.clearParam('subFolder')
assetDir.path // "assets/ntf.png"

Type

hcore/dist/type exposes the Type class which provides several static methods to identify and coerce string values intro their proper type.

// Here are some examples:

Type.isInt("3") // true
Type.isInt("3.14") // false
Type.isFloat("3") // false
Type.isFloat("3.0") // true
Type.isBoolean("1") // true
Type.isBoolean("2") // false
Type.isBoolean("true") // true
Type.isSqlDate("2020-10-12") // true

Casing

hcore/dist/casing exposes the Casing class which provides several static methods for identfying, and manipulating the case type of a string.

The supported Case Typings:

export enum CaseType {
    StdCase = 'Std case',
    CapCase = 'CAP CASE',
    UpperCase = 'Upper Case',
    LowerCase = 'lower case',
    SnakeCase = 'snake_case',
    KebabCase = 'kebab-case',
    CamelCase = 'camelCase',
    PascalCase = 'PascalCase',
}

To identify the type of string you're working with:

Casing.getType("HelloWorld") // CaseType.PascalCase
Casing.getType("hello-world") // CaseType.KebabCase
Casing.getType("hello-_world") // Throws error: Ambiguous casing

To split, join and convert case types, use:

Casing.split("HelloWorld", CaseType.PascalCase) // ["Hello", "World"]
Casing.join(["Hello", "World"], CaseType.SnakeCase) // "Hello-World"
Casing.toType("HelloWorld", CaseType.SnakeCase) // "hello-world"

You will notice that the split and join methods preserve casing. E.g. Splitting a string with Lower Case type will not cast the string to lower letter case. To do so, you can use this function to adjust the case to the proper type for each individual word. The method toType is is therefore recommended as it handles this cast for you.

Casing.convertWordToLetterType("hello", 0, CaseType.CamelCase) // hello (first word in sentence is not lower case)
Casing.convertWordToLetterType("world", 1, CaseType.CamelCase) // World

Event Listener Pool

hcore/dist/eventListenerPool exposes the EventListenerPool class which provides a simple way to manage your own custom events.

const pool = new EventListnerPool<number>();
pool.listen((x: number) => { console.log(x) });
pool.listen((x: number) => {} console.log(x * x) });

pool.emit(3);
// 3
// 9

State Machine

hcore/dist/stateMachine exposes the StateMachine class which provides a way of maintaining a set of named states that can be toggled on and off. Additionally, the event listener pool is hooked in for reactivity.

export type Algorithm = () => number[];

const algorithms = new StateMachine<Algorithm>();

algorithms.add("increment", () => [1, 2, 3, 4]);
algorithms.add("decrement", () => [4, 3, 2, 1]);

algorithms.onActivate("increment", (algo) => {
    console.log("Incrementing");
});

algorithms.onDeactivate("increment", (algo) => {
    console.log("Not Incrementing");
});

algorithms.onActivate("decrement", (algo) => {
    console.log("Decrementing");
});

algorithms.onDeactivate("decrement", (algo) => {
    console.log("Not Decrementing");
});

algorithms.activate("increment") // Incrementing
algorithms.active() // [1, 2, 3, 4]
algorithms.deactivate("increment") // Incrementing
algorithms.activate("decrement") // Decrementing
algorithms.activate("increment") // Not Decrementing, Incrementing