A Utility package for functions that cuts across all kippa microservices
npm install kippa-utilsbash
$ npm install kippa-utils
`
statusCode
- 00 (Success)
- 99 (Server Error)
- 94 (Duplicate Resource)
- 96 (Resource Not Found)
$3
kippaGrpcResponse()
`bash
import {kippaGrpcResponse} from 'kippa-utils';
const data = {
name: "Kippa",
mode: "dev"
};
return kippaGrpcResponse(data, statusCode.success, 'successful');
`
statusCode is "00" by default
message is "Operation Successful" by default
randomNumbergenerator(min, max)
`bash
const betweenOneAndTen = randomNumbergenerator(1, 10);
this generates a number between 1 and 10
`
ErrorMessages
- isRequired(fieldName);
- isNotValid(fieldName);
- isNotBoolean(fieldName);
- isNotValidDataType(variableName, fieldName);
- isEmpty(fieldName);
- isTaken(fieldName);
- isNotprovided(fieldName);
- notAuthorized(fieldName);
- internalServerError(fieldName);
- requestTimeout(fieldName);
- alreadyExists(fieldName);
- isNotFound(fieldName);
- isRequired(fieldName);
$3
`bash
import {ErrorMessages} from 'kippa-utils';
const user = [];
if(user.length == 0) {
return kippaResponse(user, statusCode.NotFound, ErrorMessages.isNotFound('user'));
}
The above show return:
{
statusCode: "96",
message: "User not found",
data: []
}
const amount = 'x';
if(typeof(amount) !== number) {
return kippaResponse({}, statusCode.NotFound, ErrorMessages.isNotValidDataType('number', amount));
}
The above show return:
{
statusCode: "96",
message: "Kindly enter a valid number for amount",
data: {}
}
``