Renamed methods & Added JSDocs

packages/app/src/utils/vo/transfer-key.ts

@@ -1,5 +1,6 @@
-const generalErrorPhrase = 'Failed to parse TransferKey from string';
-
+/**
+ * VO for TransferKey which has appUrl and key as its public member
+ */
 export class TransferKey {
 
   private static _internalSeperator = '__grw_internal_tranferkey__'
@@ -13,8 +14,15 @@ export class TransferKey {
     this.key = key;
   }
 
-  static parse(str: string): TransferKey {
-    const splitted = str.split(TransferKey._internalSeperator);
+  /**
+   * Parse a transfer key string generated by the generateKeyString static method
+   * @param {string} keyString Transfer key string
+   * @returns {TransferKey}
+   */
+  static parse(keyString: string): TransferKey {
+    const generalErrorPhrase = 'Failed to parse TransferKey from string';
+
+    const splitted = keyString.split(TransferKey._internalSeperator);
 
     if (splitted.length !== 2) {
       throw Error(generalErrorPhrase);
@@ -33,7 +41,13 @@ export class TransferKey {
     return new TransferKey(appUrl, key);
   }
 
-  static stringify(appUrl: URL, key: string): string {
+  /**
+   * Generates transfer key string (e.g. https://example.com:8080__grw_internal_tranferkey__key)
+   * @param {URL} appUrl GROWI app site url
+   * @param {string} key Key generated by GROWI
+   * @returns {string} Transfer key string
+   */
+  static generateKeyString(appUrl: URL, key: string): string {
     return `${appUrl.origin}${TransferKey._internalSeperator}${key}`;
   }