@nlabs/arkhamjs-storage-node
Version:
NodeJS storage for ArkhamJS
125 lines (124 loc) • 12.1 kB
JavaScript
function _define_property(obj, key, value) {
if (key in obj) {
Object.defineProperty(obj, key, {
value: value,
enumerable: true,
configurable: true,
writable: true
});
} else {
obj[key] = value;
}
return obj;
}
/**
* Copyright (c) 2018-Present, Nitrogen Labs, Inc.
* Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
*/ import PersistStorage from 'node-persist';
export class NodeStorage {
/**
* Removes all keys from persistent data.
*
* @returns {Promise<boolean>} Whether data was successfully removed.
*/ static clearPersistData() {
try {
return new Promise((resolve)=>{
PersistStorage.clear().then(()=>resolve(true)).catch(()=>resolve(false));
});
} catch (error) {
return Promise.resolve(false);
}
}
/**
* Removes a key from persistent data.
*
* @param {string} key Key associated with the data to remove.
* @returns {Promise<boolean>} Whether data was successfully removed.
*/ static delPersistData(key) {
try {
return new Promise((resolve)=>{
PersistStorage.removeItem(key).then(()=>resolve(true)).catch(()=>resolve(false));
});
} catch (error) {
return Promise.resolve(false);
}
}
/**
* Get a key value from persistent data.
*
* @param {string} key The key for data.
* @returns {Promise<any>} the data object associated with the key.
*/ static getPersistData(key) {
try {
return new Promise((resolve)=>{
PersistStorage.getItem(key).then((value)=>{
const updatedValue = value ? JSON.parse(value) : null;
resolve(updatedValue);
}).catch(()=>resolve(null));
});
} catch (error) {
return Promise.resolve(null);
}
}
/**
* Saves data to persistent data.
*
* @param {string} key Key to store data.
* @param {any} value Data to store.
* @returns {Promise<boolean>} Whether data was successfully saved.
*/ static setPersistData(key, value) {
try {
return new Promise((resolve)=>{
PersistStorage.setItem(key, value).then(()=>resolve(true)).catch(()=>resolve(false));
});
} catch (error) {
return Promise.resolve(false);
}
}
/**
* Clears all data from storage.
*
* @returns {Promise<boolean>} Whether data was successfully saved.
*/ clearStorageData() {
return NodeStorage.clearPersistData();
}
/**
* Get a key value from storage.
*
* @param {string} key The key for data.
* @returns {Promise<any>} the data object associated with the key.
*/ getStorageData(key) {
return NodeStorage.getPersistData(key);
}
/**
* Saves data to storage.
*
* @param {string} key Key to store data.
* @param {any} value Data to store.
* @returns {Promise<boolean>} Whether data was successfully saved.
*/ setStorageData(key, value) {
return NodeStorage.setPersistData(key, value);
}
constructor(options = {}){
_define_property(this, "options", {
dir: '/tmp',
encoding: 'utf8',
expiredInterval: 3 * 60 * 1000,
forgiveParseErrors: false,
logging: false,
parse: JSON.parse,
stringify: JSON.stringify
});
// Methods
this.clearStorageData = this.clearStorageData.bind(this);
this.getStorageData = this.getStorageData.bind(this);
this.setStorageData = this.setStorageData.bind(this);
// Configuration
this.options = {
...this.options,
...options
};
PersistStorage.init(this.options);
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["/Users/nitrog7/Development/arkhamjs/packages/arkhamjs-storage-node/src/NodeStorage/NodeStorage.ts"],"sourcesContent":["/**\n * Copyright (c) 2018-Present, Nitrogen Labs, Inc.\n * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.\n */\nimport PersistStorage, {InitOptions} from 'node-persist';\n\nexport class NodeStorage {\n  private options: InitOptions = {\n    dir: '/tmp',\n    encoding: 'utf8',\n    expiredInterval: 3 * 60 * 1000,\n    forgiveParseErrors: false,\n    logging: false,\n    parse: JSON.parse,\n    stringify: JSON.stringify\n  };\n\n  constructor(options: InitOptions = {}) {\n    // Methods\n    this.clearStorageData = this.clearStorageData.bind(this);\n    this.getStorageData = this.getStorageData.bind(this);\n    this.setStorageData = this.setStorageData.bind(this);\n\n    // Configuration\n    this.options = {...this.options, ...options};\n    PersistStorage.init(this.options);\n  }\n\n  /**\n   * Removes all keys from persistent data.\n   *\n   * @returns {Promise<boolean>} Whether data was successfully removed.\n   */\n  static clearPersistData(): Promise<boolean> {\n    try {\n      return new Promise((resolve) => {\n        PersistStorage.clear()\n          .then(() => resolve(true))\n          .catch(() => resolve(false));\n      });\n    } catch(error) {\n      return Promise.resolve(false);\n    }\n  }\n\n  /**\n   * Removes a key from persistent data.\n   *\n   * @param {string} key Key associated with the data to remove.\n   * @returns {Promise<boolean>} Whether data was successfully removed.\n   */\n  static delPersistData(key: string): Promise<boolean> {\n    try {\n      return new Promise((resolve) => {\n        PersistStorage.removeItem(key)\n          .then(() => resolve(true))\n          .catch(() => resolve(false));\n      });\n    } catch(error) {\n      return Promise.resolve(false);\n    }\n  }\n\n  /**\n   * Get a key value from persistent data.\n   *\n   * @param {string} key The key for data.\n   * @returns {Promise<any>} the data object associated with the key.\n   */\n  static getPersistData(key: string): Promise<any> {\n    try {\n      return new Promise((resolve) => {\n        PersistStorage.getItem(key)\n          .then((value: string) => {\n            const updatedValue = value ? JSON.parse(value) : null;\n            resolve(updatedValue);\n          })\n          .catch(() => resolve(null));\n      });\n    } catch(error) {\n      return Promise.resolve(null);\n    }\n  }\n\n  /**\n   * Saves data to persistent data.\n   *\n   * @param {string} key Key to store data.\n   * @param {any} value Data to store.\n   * @returns {Promise<boolean>} Whether data was successfully saved.\n   */\n  static setPersistData(key: string, value): Promise<boolean> {\n    try {\n      return new Promise((resolve) => {\n        PersistStorage.setItem(key, value)\n          .then(() => resolve(true))\n          .catch(() => resolve(false));\n      });\n    } catch(error) {\n      return Promise.resolve(false);\n    }\n  }\n\n  /**\n   * Clears all data from storage.\n   *\n   * @returns {Promise<boolean>} Whether data was successfully saved.\n   */\n  clearStorageData(): Promise<boolean> {\n    return NodeStorage.clearPersistData();\n  }\n\n  /**\n   * Get a key value from storage.\n   *\n   * @param {string} key The key for data.\n   * @returns {Promise<any>} the data object associated with the key.\n   */\n  getStorageData(key: string): Promise<any> {\n    return NodeStorage.getPersistData(key);\n  }\n\n  /**\n   * Saves data to storage.\n   *\n   * @param {string} key Key to store data.\n   * @param {any} value Data to store.\n   * @returns {Promise<boolean>} Whether data was successfully saved.\n   */\n  setStorageData(key: string, value): Promise<boolean> {\n    return NodeStorage.setPersistData(key, value);\n  }\n}\n"],"names":["PersistStorage","NodeStorage","clearPersistData","Promise","resolve","clear","then","catch","error","delPersistData","key","removeItem","getPersistData","getItem","value","updatedValue","JSON","parse","setPersistData","setItem","clearStorageData","getStorageData","setStorageData","options","dir","encoding","expiredInterval","forgiveParseErrors","logging","stringify","bind","init"],"mappings":";;;;;;;;;;;;;AAAA;;;CAGC,GACD,OAAOA,oBAAmC,eAAe;AAEzD,OAAO,MAAMC;IAsBX;;;;GAIC,GACD,OAAOC,mBAAqC;QAC1C,IAAI;YACF,OAAO,IAAIC,QAAQ,CAACC;gBAClBJ,eAAeK,KAAK,GACjBC,IAAI,CAAC,IAAMF,QAAQ,OACnBG,KAAK,CAAC,IAAMH,QAAQ;YACzB;QACF,EAAE,OAAMI,OAAO;YACb,OAAOL,QAAQC,OAAO,CAAC;QACzB;IACF;IAEA;;;;;GAKC,GACD,OAAOK,eAAeC,GAAW,EAAoB;QACnD,IAAI;YACF,OAAO,IAAIP,QAAQ,CAACC;gBAClBJ,eAAeW,UAAU,CAACD,KACvBJ,IAAI,CAAC,IAAMF,QAAQ,OACnBG,KAAK,CAAC,IAAMH,QAAQ;YACzB;QACF,EAAE,OAAMI,OAAO;YACb,OAAOL,QAAQC,OAAO,CAAC;QACzB;IACF;IAEA;;;;;GAKC,GACD,OAAOQ,eAAeF,GAAW,EAAgB;QAC/C,IAAI;YACF,OAAO,IAAIP,QAAQ,CAACC;gBAClBJ,eAAea,OAAO,CAACH,KACpBJ,IAAI,CAAC,CAACQ;oBACL,MAAMC,eAAeD,QAAQE,KAAKC,KAAK,CAACH,SAAS;oBACjDV,QAAQW;gBACV,GACCR,KAAK,CAAC,IAAMH,QAAQ;YACzB;QACF,EAAE,OAAMI,OAAO;YACb,OAAOL,QAAQC,OAAO,CAAC;QACzB;IACF;IAEA;;;;;;GAMC,GACD,OAAOc,eAAeR,GAAW,EAAEI,KAAK,EAAoB;QAC1D,IAAI;YACF,OAAO,IAAIX,QAAQ,CAACC;gBAClBJ,eAAemB,OAAO,CAACT,KAAKI,OACzBR,IAAI,CAAC,IAAMF,QAAQ,OACnBG,KAAK,CAAC,IAAMH,QAAQ;YACzB;QACF,EAAE,OAAMI,OAAO;YACb,OAAOL,QAAQC,OAAO,CAAC;QACzB;IACF;IAEA;;;;GAIC,GACDgB,mBAAqC;QACnC,OAAOnB,YAAYC,gBAAgB;IACrC;IAEA;;;;;GAKC,GACDmB,eAAeX,GAAW,EAAgB;QACxC,OAAOT,YAAYW,cAAc,CAACF;IACpC;IAEA;;;;;;GAMC,GACDY,eAAeZ,GAAW,EAAEI,KAAK,EAAoB;QACnD,OAAOb,YAAYiB,cAAc,CAACR,KAAKI;IACzC;IAlHA,YAAYS,UAAuB,CAAC,CAAC,CAAE;QAVvC,uBAAQA,WAAuB;YAC7BC,KAAK;YACLC,UAAU;YACVC,iBAAiB,IAAI,KAAK;YAC1BC,oBAAoB;YACpBC,SAAS;YACTX,OAAOD,KAAKC,KAAK;YACjBY,WAAWb,KAAKa,SAAS;QAC3B;QAGE,UAAU;QACV,IAAI,CAACT,gBAAgB,GAAG,IAAI,CAACA,gBAAgB,CAACU,IAAI,CAAC,IAAI;QACvD,IAAI,CAACT,cAAc,GAAG,IAAI,CAACA,cAAc,CAACS,IAAI,CAAC,IAAI;QACnD,IAAI,CAACR,cAAc,GAAG,IAAI,CAACA,cAAc,CAACQ,IAAI,CAAC,IAAI;QAEnD,gBAAgB;QAChB,IAAI,CAACP,OAAO,GAAG;YAAC,GAAG,IAAI,CAACA,OAAO;YAAE,GAAGA,OAAO;QAAA;QAC3CvB,eAAe+B,IAAI,CAAC,IAAI,CAACR,OAAO;IAClC;AA0GF"}