Added excludeFieldsInLog docs on readme

janis-commerce · Nov 28, 2019 · 5fb3dd0 · 5fb3dd0
1 parent 5a99ffa
commit 5fb3dd0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+## Added
+- `excludeFieldsInLog` getter documented on readme
+
 ## [3.3.2] - 2019-11-22
 ### Fixed
 - `getPaged` method is now guaranteed to process every page

diff --git a/README.md b/README.md
@@ -108,6 +108,11 @@ You can add database connection settings by adding the field names from the rece
 
 ## API
 
+### Getters
+
+* **excludeFieldsInLog** (*getter*).
+Returns the fields that will be removed from the logs as an array of strings. For example: `['password', 'super-secret']`
+
 ### const items = await myModel.get(params)
 - Returns items from database
 Params is an optional Object with filters, order, paginator.