Documentation

sebs · sebs · commit 54a0b97ee5a6 · 2019-08-07T07:10:04.000+02:00
diff --git a/src/entities/Address.ts b/src/entities/Address.ts
@@ -2,6 +2,7 @@
 import { Entity } from '../interfaces/Entity'
 import { EntityBase } from './EntityBase'
 
+// a ethereum address
 export class Address extends EntityBase implements Entity {
 	public errorMessage:string =  'invalid'
 	private address
diff --git a/src/entities/Apikey.ts b/src/entities/Apikey.ts
@@ -2,6 +2,7 @@
 import { Entity } from '../interfaces/Entity'
 import { EntityBase } from './EntityBase'
 
+// api key for etherscan.io
 export class ApiKey extends EntityBase implements Entity {
 	public errorMessage:string =  'invalid'
 	private apiKey
diff --git a/src/entities/EntityBase.ts b/src/entities/EntityBase.ts
@@ -1,5 +1,9 @@
+
+// base class for entities
 export abstract class EntityBase {
+	// basic error message for exceptions on validations
 	public errorMessage: string
+	// checks valid() and throws errorMessage
 	validate(): void {
 		if (!this.valid()) {
 			throw new Error(this.errorMessage)
diff --git a/src/entities/PositiveNumber.ts b/src/entities/PositiveNumber.ts
@@ -1,9 +1,8 @@
 
 import { Entity } from '../interfaces/Entity'
 import { EntityBase } from './EntityBase'
-/*
- * @see https://stackoverflow.com/questions/57803/how-to-convert-decimal-to-hexadecimal-in-javascript
- */
+
+// a positive number
 export class PositiveNumber extends EntityBase implements Entity {
 	public errorMessage:string =  'invalid'
 	private positiveNumber:any
diff --git a/src/entities/Sort.ts b/src/entities/Sort.ts
@@ -3,6 +3,7 @@ import { Entity } from '../interfaces/Entity'
 import { EntityBase } from './EntityBase'
 import { sort } from '../parameters/sort'
 
+// Sort Parameter asc or desc
 export class Sort extends EntityBase implements Entity {
 	public errorMessage:string =  'invalid'
 	private sortParam:string
