Readme edit ron #2
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
code4ward
reviewed
Apr 18, 2025
|
|
||
| ## Introduction | ||
| In simple terms JSOI is designed specifically for templating javascript objects. It is | ||
| In simple terms, JSOI is designed specifically to template JavaScript objects. It is |
code4ward
approved these changes
Apr 18, 2025
Owner
code4ward
left a comment
There was a problem hiding this comment.
What an improvement! Thanks Ron. No problems found just some questions. Also, I think I am going to create automatic looping. Create a new option for this. Just a heads up, we will probably need to revisit how we explain dealing with key order problems.
I just have one comment for your review, I am good on what ever you choose.
|
|
||
| After you have an instance of ```ObjectInterpolator``` you will simply invoke the ```interpolate``` method. | ||
| on the object | ||
| After you have an instance of ```ObjectInterpolator```, you will simply invoke the ```interpolate``` method on the object. |
Owner
There was a problem hiding this comment.
Should this say "you can invoke"
|
|
||
| #### Primitive types | ||
| JSOI supports type conversion on most javascript primitive types (except ```undefined```). Support, | ||
| JSOI supports type conversion on most JavaScript primitive types (except ```undefined```). Support, |
| JSOI processes replacement params in order of key iteration. This has the unintended consequence of creating a dependency | ||
| on key order in the replacement object. There are two approaches to dealing with key order, the first is to interpolate in | ||
| a loop the second is to provide the order in which you would like to process the object keys (see [Declare keys to process and processing order](#Declare-keys-to-process-and-processing-order). | ||
| a loop, the second is to provide the order in which you would like to process the object keys (see [Declare keys to process and processing order](#Declare-keys-to-process-and-processing-order). |
Owner
There was a problem hiding this comment.
Can we mention a trade off here. The point here is that providing the order of keys will be more efficient then a loop. However, a loop will be more maintainable and generally be more robust.
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.
Update to readme