Skip to content

stratoxjs/StratoxContainer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 

StratoxContainer

The JavaScript Container is an ultra-lightweight library designed to facilitate seamless communication between your other libraries.

Initialize

import { StratoxContainer } from './node_modules/stratox/src/StratoxContainer.js';
const container = new StratoxContainer();

Examples

// Example 1
container.set("someObject", { test: "Container 1" });

console.log(container.get("someObject").test);
// Log response: Container 1

// Example 2
container.set("passingAFunction", function(arg1, arg2) {
	alert(arg1+" "+arg2);
});

container.get("passingAFunction", "Hello", "world!");
// Alert response: Hello world!

Method list

Set a container or factory

set(key, value, overwrite);
  • key: Unique container key/string identifier
  • value: Mixed value of whatever you want to share, e.g. String, number, object, function.
  • overwrite: Attempting to set a container multiple times will trigger a warning unless manual consent is provided by setting "overwrite" to true.

Set factory only

setFactory(key, value, overwrite);
  • key: Unique factory key/string identifier
  • value: callable
  • overwrite: Attempting to set a container multiple times will trigger a warning unless manual consent is provided by setting "overwrite" to true.

Get a container or factory

get(key, ...args);
  • key: Unique container key/string identifier
  • args: pass arguments to possible factory/function

Check if container/factory exists

has(key);
  • key: Unique container key/string identifier

Check if is strict a "container".

isContainer(key);
  • key: Unique container key/string identifier

Check if is strict a "factory/function".

isFactory(key);
  • key: Unique factory key/string identifier

About

JavaScript container library designed for seamless communication between your libraries.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •