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

[breaking] rename invalid(...) and ValidationError #8012

Merged
merged 2 commits into from
Dec 9, 2022
Merged

Conversation

Rich-Harris
Copy link
Member

@Rich-Harris Rich-Harris commented Dec 9, 2022

Migration

invalid(..) has been renamed to fail(..):

-import { invalid } from '@sveltejs/kit';
+import { fail } from '@sveltejs/kit';

export const actions = {
  default: () => {
    // ..
-    return invalid(400, { message: 'nope' });
+    return fail(400, { message: 'nope' });
  }
};

Similarly, the ValidationError has been renamed to ActionFailure:

+import type { ValidationError } from '@sveltejs/kit';
-import type { ActionFailure } from '@sveltejs/kit';

// ..

PR description

closes #7982

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. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Dec 9, 2022

🦋 Changeset detected

Latest commit: 68781d9

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 Patch

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

@benmccann benmccann changed the title rename invalid(...) and ValidationError [breaking] rename invalid(...) and ValidationError Dec 9, 2022
@Rich-Harris Rich-Harris merged commit 3b98005 into master Dec 9, 2022
@Rich-Harris Rich-Harris deleted the gh-7982 branch December 9, 2022 17:21
@github-actions github-actions bot mentioned this pull request Dec 9, 2022
@sifferhans sifferhans mentioned this pull request Dec 16, 2022
9 tasks
ul8 added a commit to ul8/vscode-svelte-pluskit-snippets that referenced this pull request Jan 14, 2023
@benaltair
Copy link

Small thing for those still migrating old projects, the diffs here are reversed:

+import type { ValidationError } from '@sveltejs/kit';
-import type { ActionFailure } from '@sveltejs/kit';

// ..

It should be instead:

-import type { ValidationError } from '@sveltejs/kit';
+import type { ActionFailure } from '@sveltejs/kit';

// ..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename invalid to... something else?
3 participants