@@ -141,6 +141,7 @@ export class JsonDB {
141141 /**
142142 * Get the wanted data
143143 * @param dataPath path of the data to retrieve
144+ * @returns {Promise<any> }
144145 */
145146 public getData ( dataPath : string ) : Promise < any > {
146147 return readLockAsync ( async ( ) => {
@@ -152,6 +153,7 @@ export class JsonDB {
152153 /**
153154 * Same as getData only here it's directly typed to your object
154155 * @param dataPath path of the data to retrieve
156+ * @returns {Promise }
155157 */
156158 public getObject < T > ( dataPath : string ) : Promise < T > {
157159 return this . getData ( dataPath )
@@ -161,6 +163,8 @@ export class JsonDB {
161163 * Same as getData but with your own object type and a possible default value when we can't find the data path
162164 * @param dataPath path of the data to retrieve
163165 * @param defaultValue value to use when the dataPath doesn't lead to data
166+ * @returns {Promise }
167+ * @throws {DataError }
164168 */
165169 public async getObjectDefault < T > ( dataPath : string , defaultValue ?: T ) : Promise < T > {
166170 try {
@@ -179,6 +183,7 @@ export class JsonDB {
179183 /**
180184 * Check for existing datapath
181185 * @param dataPath
186+ * @returns {Promise<boolean> }
182187 */
183188 public async exists ( dataPath : string ) : Promise < boolean > {
184189 try {
@@ -195,6 +200,8 @@ export class JsonDB {
195200 /**
196201 * Returns the number of element which constitutes the array
197202 * @param dataPath
203+ * @returns {Promise<number> }
204+ * @throws {DataError }
198205 */
199206 public async count ( dataPath : string ) : Promise < number > {
200207 const result = await this . getData ( dataPath )
@@ -211,6 +218,7 @@ export class JsonDB {
211218 * @param dataPath base dataPath from where to start searching
212219 * @param searchValue value to look for in the dataPath
213220 * @param propertyName name of the property to look for searchValue
221+ * @returns {Promise<number> }
214222 */
215223 public async getIndex (
216224 dataPath : string ,
@@ -229,6 +237,7 @@ export class JsonDB {
229237 * Return the index of the value inside the array. Returns -1, if no match is found.
230238 * @param dataPath base dataPath from where to start searching
231239 * @param searchValue value to look for in the dataPath
240+ * @returns {Promise<number> }
232241 */
233242 public async getIndexValue ( dataPath : string , searchValue : string | number ) : Promise < number > {
234243 return ( await this . getArrayData ( dataPath ) ) . indexOf ( searchValue )
@@ -247,6 +256,8 @@ export class JsonDB {
247256 * Find all specific entry in an array/object
248257 * @param rootPath base dataPath from where to start searching
249258 * @param callback method to filter the result and find the wanted entry. Receive the entry and it's index.
259+ * @returns {Promise }
260+ * @throws {DataError }
250261 */
251262 public async filter < T > ( rootPath : string , callback : FindCallback ) : Promise < T [ ] | undefined > {
252263 const result = await this . getData ( rootPath )
@@ -279,6 +290,8 @@ export class JsonDB {
279290 * Find a specific entry in an array/object
280291 * @param rootPath base dataPath from where to start searching
281292 * @param callback method to filter the result and find the wanted entry. Receive the entry and it's index.
293+ * @returns {Promise }
294+ * @throws {DataError }
282295 */
283296 public async find < T > ( rootPath : string , callback : FindCallback ) : Promise < T | undefined > {
284297 const result = await this . getData ( rootPath )
@@ -308,6 +321,8 @@ export class JsonDB {
308321 * @param dataPath path leading to the data
309322 * @param data data to push
310323 * @param override overriding or not the data, if not, it will merge them
324+ * @returns {Promise<void> }
325+ * @throws {DataError }
311326 */
312327 public async push ( dataPath : string , data : any , override : boolean = true ) : Promise < void > {
313328 return writeLockAsync ( async ( ) => {
@@ -384,6 +399,8 @@ export class JsonDB {
384399 /**
385400 * Manually load the database
386401 * It is automatically called when the first getData is done
402+ * @return {Promise<void> }
403+ * @throws {DatabaseError }
387404 */
388405 public async load ( ) : Promise < void > {
389406 if ( this . loaded ) {
@@ -401,6 +418,8 @@ export class JsonDB {
401418 * Manually save the database
402419 * By default you can't save the database if it's not loaded
403420 * @param force force the save of the database
421+ * @return {Promise<void> }
422+ * @throws {DatabaseError }
404423 */
405424 public async save ( force ?: boolean ) : Promise < void > {
406425 force = force || false
@@ -413,4 +432,43 @@ export class JsonDB {
413432 throw new DatabaseError ( "Can't save the database" , 2 , err )
414433 }
415434 }
435+
436+
437+ /**
438+ * Convert a router style path to a normal path
439+ * By default propertyName to search is "id"
440+ * @param path router based path to a correct base path
441+ * @param propertyName name of the property to look for searchValue
442+ */
443+ public async fromPath ( path : string , propertyName :string = 'id' ) : Promise < string > {
444+
445+ const [ , ...pathToQuery ] = path . split ( "/" )
446+
447+ const pathObject = pathToQuery . reduce ( ( prev , curr , indexPath ) => {
448+ const isKey = indexPath % 2 === 0
449+ if ( isKey ) {
450+ prev [ `${ curr } ] = ''
451+ } else {
452+ const keys = Object . keys ( prev )
453+ prev [ `${ keys [ keys . length - 1 ] } ] = `${ curr }
454+ }
455+ return prev
456+ } , { } as { [ key : string ] :string } )
457+
458+ let normalPath : string [ ] = [ ]
459+
460+ for await ( const pathKey of Object . keys ( pathObject ) ) {
461+ normalPath . push ( `/${ pathKey } )
462+
463+ const pathValue = pathObject [ pathKey ]
464+ try {
465+ const pathIndex = await this . getIndex ( normalPath . join ( "" ) , pathValue , propertyName )
466+ normalPath . push ( `[${ pathIndex } )
467+ } catch ( error ) {
468+ throw new DataError ( `DataPath: ${ normalPath . join ( "" ) } ${ pathValue } , 13 , error )
469+ }
470+ }
471+
472+ return normalPath . join ( "" )
473+ }
416474}
![kodiakhq[bot]](https://avatars.githubusercontent.com/in/29196?v=4&size=40){kind=avatar}
0 commit comments