Conversation
commit: |
cowboyd
left a comment
There was a problem hiding this comment.
Here are a couple of tweaks:
- Let's only use the major minor version since those are the only meaningful semver points that can introduce or change an api. I.e. instead of
since @effection-v3.0.1, just@since 3.1 - I've noted it in a couple of places, but it looks as though the version is not correct. In fact, it appears that all of the versions are either 3.0 or 4.0 which means we're losing something somewhere. For example, the
scopedAPI was introduced inv3.2.0 - For interface that have methods like
Scope, we need to include their methods. For exampleScope.run()was introduced in3.0, butScope.spawn()not until3.5
| * @param operation - the operation to be encapsulated | ||
| * | ||
| * @returns the scoped operation | ||
| * @since effection-v3.0.0 |
There was a problem hiding this comment.
This was released with version 3.2.0 so I think that the algorithm might be not quite right.
| * | ||
| * @param effect - the effect to perform | ||
| * @returns an operation that performs `effect` | ||
| * @since effection-v4.0.0 |
There was a problem hiding this comment.
Do() is not part of the public api and should not be reachable via lib/mod.ts.
| * @see {@link run} | ||
| * @see {@link spawn} | ||
| * @see {@link Scope.run} | ||
| * @since effection-v3.0.0 |
There was a problem hiding this comment.
I think the Task interface was actually introduce in 2.0
| @@ -366,6 +375,7 @@ export interface Coroutine<T = unknown> { | |||
|
|
|||
| /** | |||
| * @ignore | |||
| * @since effection-v3.0.0 | |||
| */ | |||
| export interface Resolve<T> { | |||
There was a problem hiding this comment.
We don't need since tags for ignored APIs since they are not part of the public api and should not be relied upon.
| * @template {T} | ||
| * @param promise | ||
| * @returns {Operation<T>} that succeeds or fails depending on the outcome of `promise` | ||
| * @since effection-v3.0.0 |
There was a problem hiding this comment.
I believe this was introduced in v3.4.0, so again, we may need to revisit the logic.
|
@alexvyber you've done all of the heavy lifting here. I don't want to rush you, but I do want to extend an hand in case you need help driving this over the finish line. Please let me know if there is anything I can do to help. |
Closes #1039
Adds
@sincetags to exports