Update src/collections/domain/useCases/GetCollection.ts

ekraffmiller · g-saracca · web-flow · commit 9f7fae211d27 · 2024-10-30T18:26:13.000-04:00
fix comments in GetCollection.ts

Co-authored-by: German Gonzalo Saracca &lt;germansaracca@theagilemonkeys.com&gt;
diff --git a/src/collections/domain/useCases/GetCollection.ts b/src/collections/domain/useCases/GetCollection.ts
@@ -13,7 +13,7 @@ export class GetCollection implements UseCase<Collection> {
    * Returns a Collection instance, given the search parameters to identify it.
    *
    * @param {number | string} [collectionIdOrAlias = ':root'] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)
-   * If this parameter is not set, the default value is: 'root'
+   * If this parameter is not set, the default value is: ':root'
    * @returns {Promise<Collection>}
    */
   async execute(collectionIdOrAlias: number | string = ROOT_COLLECTION_ID): Promise<Collection> {

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export class GetCollection implements UseCase<Collection> {`
`13`	`13`	`* Returns a Collection instance, given the search parameters to identify it.`
`14`	`14`	`*`
`15`	`15`	`* @param {number \| string} [collectionIdOrAlias = ':root'] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)`
`16`		`- * If this parameter is not set, the default value is: 'root'`
	`16`	`+ * If this parameter is not set, the default value is: ':root'`
`17`	`17`	`* @returns {Promise<Collection>}`
`18`	`18`	`*/`
`19`	`19`	`async execute(collectionIdOrAlias: number \| string = ROOT_COLLECTION_ID): Promise<Collection> {`