From 35bea9063f50fc6220de7fff628e4e8b9464b7c1 Mon Sep 17 00:00:00 2001 From: Shuffledex Date: Thu, 16 Jan 2020 09:10:14 -0300 Subject: [PATCH] fix: documentation --- src/entities/SecurityTokenReservation.ts | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/src/entities/SecurityTokenReservation.ts b/src/entities/SecurityTokenReservation.ts index 5475c6a..5d8a7ac 100644 --- a/src/entities/SecurityTokenReservation.ts +++ b/src/entities/SecurityTokenReservation.ts @@ -6,7 +6,7 @@ import { PolymathError } from '../PolymathError'; import { ErrorCode } from '../types'; /** - * Represents a unique security token reservation + * Properties that uniquely identify a Security Token Reservation */ export interface UniqueIdentifiers { symbol: string; @@ -14,8 +14,6 @@ export interface UniqueIdentifiers { /** * Check if the provided value is of type [[UniqueIdentifiers]] - * - * @param identifiers - internal security token reservation representation */ function isUniqueIdentifiers(identifiers: any): identifiers is UniqueIdentifiers { const { symbol } = identifiers; @@ -24,16 +22,13 @@ function isUniqueIdentifiers(identifiers: any): identifiers is UniqueIdentifiers } /** - * Represents a single Security Token Reservation + * Constructor parameters */ export interface Params { /** * expiry date for the ticker reservation */ expiry: Date; - /** - * date at which ticker is registered - */ reservedAt: Date; ownerAddress: string; securityTokenAddress?: string; @@ -44,7 +39,7 @@ export interface Params { */ export class SecurityTokenReservation extends Entity { /** - * Transform object to string + * Generate the Security Token Reservation's UUID from its identifying properties */ public static generateId({ symbol }: UniqueIdentifiers) { return serialize('securityTokenReservation', { @@ -158,7 +153,7 @@ export class SecurityTokenReservation extends Entity { }; /** - * Convert entity as a POJO (Plain Old Javascript Object) + * Convert entity to a POJO (Plain Old Javascript Object) */ public toPojo() { const { uid, symbol, expiry, securityTokenAddress, reservedAt, ownerAddress } = this; @@ -167,7 +162,7 @@ export class SecurityTokenReservation extends Entity { } /** - * Hydrating the entity + * Hydrate the entity */ public _refresh(params: Partial) { const { expiry, securityTokenAddress, reservedAt, ownerAddress } = params;