Added docs about the new censor function. #553
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jsumners
approved these changes
Nov 22, 2018
docs/api.md
Outdated
| @@ -105,7 +105,9 @@ Each path must be a string using a syntax which corresponds to JavaScript dot an | |||
|
|
|||
| If an object is supplied, three options can be specified: | |||
| * `paths` (array): Required. An array of paths. See [redaction - Path Syntax ⇗](/docs/redaction.md#paths) for specifics. | |||
| * `censor` (String): Optional. A value to overwrite key which are to be redacted. Default: `'[Redacted]'` | |||
| * `censor` (String|Function): Optional. A value to overwrite key which are to be redacted. | |||
|
PTAL |
davidmarkclements
previously requested changes
Nov 22, 2018
Co-Authored-By: mcollina <matteo.collina@gmail.com>
Co-Authored-By: mcollina <matteo.collina@gmail.com>
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We missed to update the docs.