fix: adds jsdoc comments (#768)

stalniy · May 5, 2023 · 6ca6105 · 6ca6105
1 parent cfa1acb
commit 6ca6105
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/packages/casl-ability/src/Ability.ts b/packages/casl-ability/src/Ability.ts
@@ -28,6 +28,9 @@ export interface MongoAbility<
   C extends MongoQuery = MongoQuery
 > extends PureAbility<A, C> {}
 
+/**
+ * Creates Ability with MongoDB conditions matcher
+ */
 export function createMongoAbility<
   T extends AnyMongoAbility = MongoAbility
 >(rules?: RawRuleOf<T>[], options?: AbilityOptionsOf<T>): T;

diff --git a/packages/casl-mongoose/src/mongo.ts b/packages/casl-mongoose/src/mongo.ts
@@ -6,6 +6,9 @@ function convertToMongoQuery(rule: AnyMongoAbility['rules'][number]) {
   return rule.inverted ? { $nor: [conditions] } : conditions;
 }
 
+/**
+ * Converts ability action + subjectType to MongoDB query
+ */
 export function toMongoQuery<T extends AnyMongoAbility>(
   ability: T,
   subjectType: Parameters<T['rulesFor']>[1],