README

node-containerpattern

A 'Container pattern' object for a clean global use of data. Basicaly, it extends Map object with lot of controls, recursive methods and documentation

Installation

$ npm install node-containerpattern

Features

Remember data by there choosen keys
use optional skeleton to ensure data formats
Access to the data easily and recursively
Check recursively data by the key and the value
Manipule the data : set, get, has, delete, ...
Easily create documenation

Doc

-- Inheritance --

check the official 'Map' object documentation

-- Types & interfaces --

-- Constructor --

constructor(recursionSeparator: string = ".")

-- Attributes --

documentations: object
limits: object
mins: object
maxs: object
regexs: object
recursionSeparator: string
skeletons: object

-- Methods --

clear(): this clearData & clearDocumentations & clearLimits & clearSkeletons
clearData() : this forget all the keys and there values and documentations (=> Map.clear)
clearDocumentations() : this forget all the skeletons
clearLimits() : this forget all the limits
clearMinsMaxs() : this forget all the min & max limits
clearSkeletons() : this forget all the skeletons
delete(key: string) : this forget a key and its value
document(key: string, documentation: string) : this attach a documentation on the data. only visible if "set" method is applied with this key.
documentation() : JSON object generate a documentation for all the stored data
get(key: string) : mixed the value in association with this key (may be recursive)
has(key: string) : bool check if a key is used (may be recursive)
min(key: string, min: integer) : this associate a key with a min value (min length for string & array) (MUST have a valid skeleton : [ "array", "color", "email", "float", "ipv4", "ipv6, "integer", "string", "url" ])
max(key: string, max: integer) : this associate a key with a max value (max length for string & array) (MUST have a valid skeleton : same as min)
regex(key: string, regex: RegExp) : this associate a key with a pattern (MUST have a valid skeleton : [ "color", "email", "ipv4", "ipv6", "string", "url" ]) (useless with "color", "email", "ipv4", "ipv6", & "url", tested with natives checkers. more usefull with "string")
limit(key: string, limit: Array<string>) : this associate a key with a limit
set(key: string, mixed value) : this associate and remember a key with a value (may be recursive)
skeleton(key: string, skeleton: tType) : this

-- notes --

if the skeleton is an 'array' or an 'object', and value data is a string, JSON.parse is apply before throw any error
if the skeleton is an 'color', 'email', 'ipv4', 'ipv6', 'url', value must be a string. it can be empty, but must be a valid address if not

Examples

Native

const Container = require("node-containerpattern");
const container = new Container();

container
  .skeleton("contact", "email").document("contact", "Contact address")
  .skeleton("debug", "boolean").document("debug", "This is the debug module")
  .skeleton("vat", "float")
  .skeleton("heigth", "integer")

  .set("contact", "myaddress@provider.com")
  .set("debug", true) // '"yes"', '"y"', '"1"', '1', '"true"' or 'true' => get = true, else => get = false
  .set("vat", '5.5').set('vat', 5.5)
  .set("conf", { usr : { login : 'login', pwd : 'pwd' } })
  .set("conf.usr.login", "login2")
  .set("object", new Object())

  .min("contact", 6) // min length : 6 (x@x.xx)
  .limit("debug", [true, false]) // debug is now limited to 'true' or 'false'
  .min("vat", 0).max("vat", 50); // cannot be less than 0% or more than 50%

console.log(container.get("conf").usr.login);
console.log(container.get("conf.usr.login"));
console.log(container.get("object"));
console.log(container.get("conf"));

container.delete("object");

console.log(container.has("object"));
console.log(container.size);

for (let key of container.keys()) {
  console.log(key);
}
for (let value of container.values()) {
  console.log(value);
}

container.forEach((value, key) => {
  console.log("container[" + key + "] = " + value);
});

console.log(container.documentation());

container.clear();

Typescript

import Container = require("node-containerpattern");
const container = new Container();

container
  .skeleton("contact", "email").document("contact", "Contact address")
  .set("contact", "myaddress@provider.com");

console.log(container.get("contact"));

Tests

$ npm run-script tests

License

ISC

Usage no npm install needed!