README

This is a basic library which is used in IoTell nodejs projects. It is programmed in TypeScript.

How do I set it up?

• Installation: 'npm i iotellnodelib'
• Run: 'npm install' to install dependencies

How do I use it?

• Function libraries are all accessible through the object named 'lib'. It contains the following properties:
  • array: Array library
  • date: Date library
  • enum: enum library
  • id: id library
  • logger: logging library
  • object: object library
  • rejectPromise: promise rejection library
  • regexp: regExp library
  • schema: JSON schema library
  • string: string library
• Classes are accessible by their class names:
  • Logger : Logger class
  • Message : Different types of messages which are used for logs and request-responses. For promise-rejections please use lib.rejectPromise.
  • MyError : Standard iotell error class.
  • BadRequestError : Returns an 400 Error
• Special enums:
  • HttpMethod: A httpmethod enum of methods which we use in the project.
  • HttpCodes : A list of http codes.

Development

• Start development: npm run buildw
• Running tests : npm run test