Skip to content

Commit

Permalink
feat: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iamnasirudeen committed Nov 25, 2024
1 parent 279986b commit ec233ca
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,10 @@ This takes in a string and checks if the strings contains a secret, if it does,
import { scanSecretsInString } from 'securelogs';

const safeString = await scanSecretsInString(
'This is a very long string with AKIAKSDKDBDSDSDBD AWS secrets attached'
); // This is a very long string with AKIA******** AWS secrets attached
'This is a very long string with AKIAKSDKDBDSDSDBD AWS secrets attached',
options: {
maskedValue: "*"; // that is the masked value should be represented by "*", if masked value is an empty string, all found secrets wont have a value
visibleChars: 0; // that is no detected secrets should be returned
}
); // This is a very long string with AWS secrets attached
```

0 comments on commit ec233ca

Please sign in to comment.