feat(project): add serializeSync method #549
Conversation
patricksmms
force-pushed
the
patricksmms/add-fury-serialize-sync
branch
from
e157e7e to
a169684
Compare
This reverts commit 877bfb4.
patricksmms
force-pushed
the
patricksmms/add-fury-serialize-sync
branch
from
b0754f6 to
fc81a6d
Compare
patricksmms
force-pushed
the
patricksmms/add-fury-serialize-sync
branch
from
fc81a6d to
2b80fbe
Compare
packages/core/lib/fury.js
Outdated
|
|
||
| /** | ||
| * Serialize an API Description into the given output format. | ||
| * Serialize asynchronously an API Description into the given output format. |
There was a problem hiding this comment.
Grammatically, I think it would sound better to change the order here. The adverb (asynchronously) describes the word serialise. I think the rules of time adverbs would apply here so either "asynchronously serialise" or "serialise X asynchronously" instead of "serialise asynchronously X"
| * Serialize asynchronously an API Description into the given output format. | |
| * Asynchronously serialize an API Description into the given output format. |
There was a problem hiding this comment.
Addressed in 20ee86c
| }); | ||
| }); | ||
|
|
||
| it(`serializes synchronously ${path.basename(file)}`, (done) => { |
There was a problem hiding this comment.
Since this isn't an async API, perhaps it would be clearer to omit done. I think the test would be simpler without it since you won't need to wrap the blocks in try/catch as throwing from the test would trigger test failure.
There was a problem hiding this comment.
Addressed in cd072b1
packages/cli/CHANGELOG.md
Outdated
| @@ -1,5 +1,11 @@ | |||
| # API Elements: CLI Changelog | |||
|
|
|||
| ## 0.10.3 (2019-08-31) | |||
There was a problem hiding this comment.
No strong opinions here, although we don't necessarily need to release the CLI as these changes have no impact on it. The new version of the apib serialize adapter is also compatible with the existing version "@apielements/apib-serializer": "^0.16.1", so installing CLI would get updated apib-serializer regardless.
There was a problem hiding this comment.
Right. I saw similar releases on the past, that's why I did it.
There was a problem hiding this comment.
The past ones are usually a slightly different case where the version range didn't suffice (or core changed). Such as minor releases which don't fit into the patch range (0.17 for example won't fit into that range, and might trigger CLI release).
There was a problem hiding this comment.
In that case I'll drop this release.
There was a problem hiding this comment.
Dropped in e0d00c3
patricksmms
changed the title
Adding method that is more convenient to use, when not running on a web worker or as a service, as it blocks the main-thread regardless.