Use name instead of id for instances in Workflows binding #2881
+35
−24
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
sidharthachatterjee
force-pushed
the
sidharthachatterjee/workflows-instances-name
branch
from
0310fff
to
1459d75
Compare
jasnell
approved these changes
Oct 9, 2024
LuisDuarte1
suggested changes
Oct 10, 2024
| * @param params The payload to send over to this instance | ||
| * @returns A promise that resolves with a handle for the Instance | ||
| */ | ||
| public create(id: string, params: object): Promise<Instance>; | ||
| public create(name: string, params: object): Promise<Instance>; |
There was a problem hiding this comment.
I think it would be better to create a CreateInstanceParams interface, to allow for better extensibility (we are making breaking changes anyway)
| * @param params The payload to send over to this instance | ||
| * @returns A promise that resolves with a handle for the Instance | ||
| */ | ||
| public create(id: string, params: object): Promise<Instance>; | ||
| public create(name: string, params: object): Promise<Instance>; |
There was a problem hiding this comment.
params should be unknown and not an object
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.
This is a breaking chance but the binding is currently experimental so that is okay
The Workflow binding currently accepts an
idfor its create and get functions. We now allow users to pass in a user defined "instance name". This can be used to lookup instances that were previously created.