Skip to content
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

feat: add action failure helper #12878

Merged
merged 6 commits into from
Nov 5, 2024
Merged

feat: add action failure helper #12878

merged 6 commits into from
Nov 5, 2024

Conversation

eltigerchino
Copy link
Member

@eltigerchino eltigerchino commented Oct 25, 2024

closes #12611

Exposes a helper method to check if a variable is an instanceof ActionFailure


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Oct 25, 2024

🦋 Changeset detected

Latest commit: ac9a325

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@eltigerchino eltigerchino added the forms Stuff relating to forms and form actions label Oct 25, 2024
* Checks whether this is an action failure thrown by {@link fail}.
* @param e The object to check.
* */
export function isActionFailure(e: unknown): e is ActionFailure_1<undefined>;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Through this I'm realizing just now that we're not returning "is this interface" but rather "is this class" from that. We should definitely change it for the new function to refer to the interface instead, not sure if it's seen as a breaking change to change it for the others, too

Copy link
Member Author

@eltigerchino eltigerchino Oct 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean we should change them to not use instanceof for the check? Or simply changing the return type to use the interface:

/**
 * Checks whether this is an action failure thrown by {@link fail}.
 * @param {unknown} e The object to check.
- * @return {e is ActionFailure}
+ * @return {e is import('./public.js').ActionFailure}
 */
export function isActionFailure(e) {
	return e instanceof ActionFailure;
}

It would be a breaking change for the other helpers I think.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there's a breaking change we want to eventually make for the others, can you file an issue and add it to the 3.0 milestone so that we don't forget?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've created one here #12986

@dummdidumm dummdidumm merged commit 92b2686 into main Nov 5, 2024
10 checks passed
@dummdidumm dummdidumm deleted the action-failure-helper branch November 5, 2024 19:30
@github-actions github-actions bot mentioned this pull request Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
forms Stuff relating to forms and form actions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Export ActionFailure to allow instanceof
3 participants