Update cancel method

[CahidArda]

update client.cancel to cancel all workflows or cancel a set of workflows or based on a workflow url

There are multiple ways you can cancel workflows:

• pass one or more workflow run ids to cancel them
• pass a workflow url to cancel all runs starting with this url
• don't pass any options. in this case, all workflow will be canceled

Cancel a set of workflow runs

// cancel a single workflow
await client.cancel({ ids: "<WORKFLOW_RUN_ID>" })

// cancel a set of workflow runs
await client.cancel({ ids: [
  "<WORKFLOW_RUN_ID_1>",
  "<WORKFLOW_RUN_ID_2>",
]})

Cancel workflows starting with a url

If you have an endpoint called https://your-endpoint.com and you
want to cancel all workflow runs on it, you can use urlStartingWith.

Note that this will cancel workflows in all endpoints under
https://your-endpoint.com.

await client.cancel({ urlStartingWith: "https://your-endpoint.com" })

Cancel all workflows

If you want to cancel all workflows under your user, you can
do it like this:

await client.cancel({ all: true })

[joschan21]

wdyt about offering the following 3 options for the cancel interface

• ids?: string | string[]
• urlStartingWith?: string for url-based cancellation, more clear about the "starting with" behavior
• all?: boolean to cancel all pending runs

[fahreddinozcan]

I think cancelling all on await client.cancel() would allow people to make mistakes while cancelling. It's also not that intuitive. I'd agree with client.cancel({all: true})

[CahidArda]

all parameter sounds good. Updating parameters like this:

type CancelOptions = {
  workflowRunId?: string | string[];
  workflowUrl?: string;
  all?: true;
};

[joschan21]

what about the rest?

[CahidArda]

got tunnel visioned with all :D

others make sense too, updated the pr.

[joschan21]

LGTM