Adding initial writeup of wrapper-layer.md #28
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
nciric
reviewed
Apr 15, 2020
docs/wrapper-layer.md
Outdated
|
|
||
| When a programmer writes code using Intl, the code they write should demonstrate their *intent*. They should use what I'm calling the *ergonomic API* of OmnICU. | ||
|
|
||
| A *logical API*, on the other hand, is one that is closely tied to specific to functional units, like currencies or measurement units. A logical API function should require a specific hunk of data and perform a specific task. |
There was a problem hiding this comment.
to specific functional units?
nciric
reviewed
Apr 15, 2020
docs/wrapper-layer.md
Outdated
|
|
||
| When a programmer writes code using Intl, the code they write should demonstrate their *intent*. They should use what I'm calling the *ergonomic API* of OmnICU. | ||
|
|
||
| A *logical API*, on the other hand, is one that is closely tied to specific to functional units, like currencies or measurement units. A logical API function should require a specific hunk of data and perform a specific task. |
There was a problem hiding this comment.
Is this what we call business logic or low level API?
There was a problem hiding this comment.
I'm calling it "logical", but you could also call it "low level", etc. Not sure if "business" invokes the correct meaning.
nciric
reviewed
Apr 15, 2020
docs/wrapper-layer.md
Outdated
|
|
||
| Although ergonomic APIs correspond with what users of i18n intend to do, from an implementation standpoint, they are often quite heavy-weight, pulling in many dependencies that may not be required for all call sites. Intl.NumberFormat is an example: it supports currency formatting, which requires a lot of code and data, but when formatting a number that's not a currency, you shouldn't need to carry all that extra code and data. | ||
|
|
||
| The goal of the *wrapper layer* is to provide an ergonomic API for clients, but map it to the logical API under the hood. |
There was a problem hiding this comment.
So to clarify:
- Wrapper layer implements ergonomic API
- Is resolving user request (options, locale,...) into potential data fetch, and is passing data to logical API under the hood.
There was a problem hiding this comment.
Right. Clarified in the paragraph.
nciric
reviewed
Apr 15, 2020
nciric
reviewed
Apr 15, 2020
nciric
reviewed
Apr 15, 2020
Closed
Closed
Closed
echeran
reviewed
Apr 20, 2020
|
Ping for review/approval |
echeran
approved these changes
Apr 30, 2020
|
Whoops, I should change |
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.
Also see #26
Closes #2