-
Notifications
You must be signed in to change notification settings - Fork 296
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use name instead of id for instances in Workflows binding #2881
Open
sidharthachatterjee
wants to merge
1
commit into
main
Choose a base branch
from
sidharthachatterjee/workflows-instances-name
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+35
−24
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,18 +15,18 @@ declare module "cloudflare:workflows" { | |
declare abstract class Workflow { | ||
/** | ||
* Get a handle to an existing instance of the Workflow. | ||
* @param id Id for the instance of this Workflow | ||
* @param name Name of the instance of this Workflow | ||
* @returns A promise that resolves with a handle for the Instance | ||
*/ | ||
public get(id: string): Promise<Instance>; | ||
public get(name: string): Promise<Instance>; | ||
|
||
/** | ||
* Create a new instance and return a handle to it. If a provided id exists, an error will be thrown. | ||
* @param id Id to create the instance of this Workflow with | ||
* Create a new instance and return a handle to it. If a provided instance name exists, an error will be thrown. | ||
* @param name Name to create the instance of this Workflow with | ||
* @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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
} | ||
|
||
type InstanceStatus = { | ||
|
@@ -49,6 +49,7 @@ interface WorkflowError { | |
|
||
declare abstract class Instance { | ||
public id: string; | ||
public name: string; | ||
|
||
/** | ||
* Pause the instance. | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be better to create a
CreateInstanceParams
interface, to allow for better extensibility (we are making breaking changes anyway)