message-handler
v0.0.17
Published
Message handler for node
Downloads
5
Readme
Message handler
Setup
To setup messages a json file with the following structure is needed
{
"1": {
"1001": {
code: 1001,
msg: "example text"
// can be as many as you need
},
"1002": {
code: 1002,
msg: "example text"
// can be as many as you need
}
},
"2": {
"2001": {
code: 2001,
msg: "example text"
// can be as many as you need
},
"2002": {
code: 2002,
msg: "example text"
// can be as many as you need
}
}
}
You can structure the json anyway you want within the example above.
And now to initialize the json object you run
const mh = require('message-handler');
mh(__dirname + '/path/to/file');
Variables
In the json you can write variables which will be replaced by a string, number or object. This is achieved with '$!{number}' in the following way (there can be as many as you need)
{
"1": {
"1001": {
code: 1001,
msg: "$!1", // Var
type: "$!2" // Var
// can be as many as you need
},
"1002": {
code: 1002,
msg: "example text"
// can be as many as you need
}
},
"2": {
"2001": {
code: 2001,
msg: "example text"
// can be as many as you need
},
"2002": {
code: 2002,
msg: "example text"
// can be as many as you need
}
}
}
Then to use the handler run the following function
console.log(
mh.messageHandler(1001, [
'Example text', // This will replace $!1 with the text in message 1001
{ // This will replace $!2 with the object in message 1001
test: example,
example: test
};
])
);
( you dont need to give an array )
Known issues
If there are 2 instances of setup being ran there will be an overwrite Working on a fix