feat: Add redactText
#43
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
72636c
approved these changes
May 2, 2022
src/formatters/index.ts
Outdated
| /** | ||
| * This allows finer control of redaction by providing access to the full text. | ||
| */ | ||
| redactLog?: (input: string, redactedDummy: string) => string; |
There was a problem hiding this comment.
Thoughts on naming:
Suggested change
| redactLog?: (input: string, redactedDummy: string) => string; | |
| redactText?: (logText: string, redactionPlaceholder: string) => string; |
There was a problem hiding this comment.
Yea those sound better 🙇 , I'll go with those 👍
Co-authored-by: Ryan Ling <rling@seek.com.au>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose
Currently there's no way to redact specific fields within a string, you'd have to redact the entirety of the string via the
redactoption.Approach
This allows consumers to pass in a function that would have access to the full text log, and allow them to redact specific strings within it.
Notes
N/A
Issues
Related to https://github.com/SEEK-Jobs/indie-jepsen/pull/240.