From b7032e3f840b900006d07ed12f40444f5c950234 Mon Sep 17 00:00:00 2001 From: Zixuan Liu Date: Wed, 12 Aug 2020 23:50:14 +0800 Subject: [PATCH] chore: bump to v2.2.1 Signed-off-by: Zixuan Liu --- API.md | 13 ++++++++++--- package.json | 2 +- src/adapter.js | 2 +- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/API.md b/API.md index 55a4947..1106901 100644 --- a/API.md +++ b/API.md @@ -9,7 +9,8 @@ Implements a policy adapter for casbin with MongoDB support. * [new MongooseAdapter(uri, [options])](#new_MongooseAdapter_new) * _instance_ * [._open()](#MongooseAdapter+_open) ⇒ Promise.<void> - * [.setFiltered([filtered])](#MongooseAdapter+setFiltered) + * [.setFiltered([enable])](#MongooseAdapter+setFiltered) + * [.isFiltered()](#MongooseAdapter+isFiltered) ⇒ boolean * [.setSynced([synced])](#MongooseAdapter+setSynced) * [.setAutoAbort([abort])](#MongooseAdapter+setAutoAbort) * [.setAutoCommit([commit])](#MongooseAdapter+setAutoCommit) @@ -59,7 +60,7 @@ Opens a connection to mongoDB **Kind**: instance method of [MongooseAdapter](#MongooseAdapter) -### mongooseAdapter.setFiltered([isFiltered]) +### mongooseAdapter.setFiltered([enable]) Switch adapter to (non)filtered state. Casbin uses this flag to determine if it should load the whole policy from DB or not. @@ -67,8 +68,14 @@ Casbin uses this flag to determine if it should load the whole policy from DB or | Param | Type | Default | Description | | --- | --- | --- | --- | -| [isFiltered] | Boolean | true | Flag that represents the current state of adapter (filtered or not) | +| [enable] | Boolean | true | Flag that represents the current state of adapter (filtered or not) | + + +### mongooseAdapter.isFiltered() ⇒ boolean +isFiltered determines whether the filtered model is enabled for the adapter. + +**Kind**: instance method of [MongooseAdapter](#MongooseAdapter) ### mongooseAdapter.setSynced([synced]) diff --git a/package.json b/package.json index 710ce75..85b8122 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "casbin-mongoose-adapter", - "version": "2.2.0", + "version": "2.2.1", "description": "Mongoose adapter for Casbin", "main": "src/adapter.js", "license": "Apache-2.0", diff --git a/src/adapter.js b/src/adapter.js index 5d64aeb..6ac8819 100644 --- a/src/adapter.js +++ b/src/adapter.js @@ -125,7 +125,7 @@ class MongooseAdapter { * Switch adapter to (non)filtered state. * Casbin uses this flag to determine if it should load the whole policy from DB or not. * - * @param {Boolean} [isFiltered=true] Flag that represents the current state of adapter (filtered or not) + * @param {Boolean} [enable=true] Flag that represents the current state of adapter (filtered or not) */ setFiltered (enable = true) { this.filtered = enable;