annotation-js

`` Publication date: February 22, 2017 `

Module for annotation in Javascript.

Annotation template:
`javascript
/*
@Annotation(
DATA[query="",column="",type="",sufix="",dir=""]
)
@type{class,number,integer(remove all outher caracterer),date,boolean,string}
@sufix{}
*/
`

Example usage:

 - Add the notations in the classes:

`javascript
class Contact {
constructor(email = null, phone = null, age = null) {
/*
@Annotation(
ANNOTATION_NAME_1[informationName="param_email"],
ANNOTATION_NAME_2[informationName="param_email_2"],
)
@type{string}
*/
this.email = email;
/*
@Annotation(
ANNOTATION_NAME_1[informationName="param_phone"],
ANNOTATION_NAME_2[informationName="param_phone_2"],
)
@type{string}
*/
this.phone = phone;
/*
@Annotation(
ANNOTATION_NAME_1[informationName="param_age"],
ANNOTATION_NAME_2[informationName="param_age_2"],
)
@type{integer}
*/
this.age = age;
}
}
class OutherData {
constructor(id = null, description = null) {
/*
@Annotation(
ANNOTATION_NAME_1[informationName="param_id",dir="BIND_INOUT"],
ANNOTATION_NAME_2[informationName="param_id_2"],
)
@type{number}
*/
this.id = id;
/*
@Annotation(
ANNOTATION_NAME_1[informationName="param_description"],
ANNOTATION_NAME_2[informationName="param_description_2"],
)
@type{string}
*/
this.description = description;
/*
@Annotation(
ANNOTATION_NAME_1[informationName="param_cpf",dir="BIND_INOUT"],
ANNOTATION_NAME_2[informationName="param_cpf_2"],
)
@type{integer}
*/
this.cpf = cpf; //If "123.456.789.12" is seted, all characters other than numbers will be removed, resulting "12345678912"
}
}
class User {
constructor() {
/*
@Annotation(
ANNOTATION_NAME_1[informationName="param_name"],
ANNOTATION_NAME_2[informationName="param_name_2"],
)
@type{string}
*/
this.name = 'João';
/*
@Annotation(
ANNOTATION_NAME_1[informationName="param_is_dev"],
ANNOTATION_NAME_2[informationName="param_is_dev_2"],
)
@type{boolean}
*/
this.isDeveloper = true;
/*
@Annotation(
ANNOTATION_NAME_1[informationName="param_date_created"],
ANNOTATION_NAME_2[informationName="param_date_created_2"],
)
@type{date}
*/
this.dateCreated = new Date('2017-03-23');
/*
@Annotation()
@type{class}
*/
this.contact = new Contact('joaojunior.mail@gmail.com', '99 9999-9999', 29);
/*
@Annotation()
@type{class}
@sufix{_1}
*/
this.data1 = new OutherData(10, 'Teste1');
/*
@Annotation()
@type{class}
@sufix{_2}
*/
this.data2 = new OutherData(20, 'Teste2');
}
}
`
 - Method for reading notation (generic):

`javascript
User.getAnnotations(,);
`
Example:
`javascript
var annotation = User.getAnnotations('ANNOTATION_NAME_1',2);
`
 - Method for reading notation (popular data in object through an array):
`javascript
global.populateToService(, , ,, ,);
`
Exemplo:
`javascript
var user = new User();
global.populateToService(user, {param_date_created:new Date(),param_name:'John'}, "query", "ANNOTATION_NAME_1", "informationName", 2);
`
 - Method for reading notation for bindVars of the module `npm oracledb`:
`javascript
global.populateToPersistence(, , ,,);
`
Example:
`javascript
var bindVars = null;
var stringToEval = global.populateToPersistence(user, "ANNOTATION_NAME_1", "user", "informationName", 3);
eval(stringToEval);
bindVars = Object.assign({}, bindVars, {
cursor: {dir: oracledb.BIND_OUT, type: oracledb.CURSOR, maxSize: 2}
});
`
 - Generic SQL Generation Method (INSERT, UPDATE):
`javascript
global.generateSQL(, , , ,, ,);
`
Example:
`javascript
var sql = global.generateSQL(user, "UPDATE", "TB_CLIENT", "id = 1", "ANNOTATION_NAME_1", "informationName", 3);
console.log(sql);
`
 - Debug Mode:
`javascript
global.annotationsDebug = true; //Default: true
``