docs: mention template literals in fake docs #701
Merged
Conversation
This file contains hidden or 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
Codecov Report
@@ Coverage Diff @@
## main #701 +/- ##
=======================================
Coverage 99.34% 99.34%
=======================================
Files 1923 1923
Lines 176887 176890 +3
Branches 897 897
=======================================
+ Hits 175732 175735 +3
Misses 1099 1099
Partials 56 56
|
Co-authored-by: Leyla Jähnig <[email protected]>
ejcheng
approved these changes
Mar 28, 2022
Shinigami92
approved these changes
Mar 28, 2022
pkuczynski
reviewed
Mar 28, 2022
| @@ -17,7 +17,10 @@ export class Fake { | |||
| /** | |||
| * Generator method for combining faker methods based on string input. | |||
There was a problem hiding this comment.
Suggested change
| * Generator method for combining faker methods based on string input. | |
| * Generator method for combining faker methods based on static string input. |
| @@ -17,7 +17,10 @@ export class Fake { | |||
| /** | |||
| * Generator method for combining faker methods based on string input. | |||
| * | |||
| * This will check the given string for placeholders and replace them by calling the specified faker method. | |||
| * Note: If you just want to create a string on the fly, we recommend using string template literals instead. | |||
There was a problem hiding this comment.
Suggested change
| * Note: If you just want to create a string on the fly, we recommend using string template literals instead. | |
| * Note: If you want to create a string combining a few different faker elements, we recommend using string template literals instead of `fake`, eg. `const address = `${faker.address.zipCode} ${faker.address.city}`` |
| @@ -17,7 +17,10 @@ export class Fake { | |||
| /** | |||
| * Generator method for combining faker methods based on string input. | |||
| * | |||
| * This will check the given string for placeholders and replace them by calling the specified faker method. | |||
| * Note: If you just want to create a string on the fly, we recommend using string template literals instead. | |||
| * This method is useful if you wish to choose a random format from a non-executable source or persistent storage (json etc.). | |||
There was a problem hiding this comment.
Suggested change
| * This method is useful if you wish to choose a random format from a non-executable source or persistent storage (json etc.). | |
| * This method is useful though if you wish to build a random string from a static, non-executable source (eg string coming from a user, stored in a database or a file). |
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.
Created to clarify the usage recommendations of
faker.fake():https://discord.com/channels/929487054990110771/957954416286261288