Hide isAbortError from public API

.changeset/loud-pumas-chew.md

@@ -0,0 +1,5 @@
+---
+'@farfetched/core': minor
+---
+
+Hide `isAbortError` from public API

apps/website/docs/api/utils/error_guards.md

@@ -30,19 +30,6 @@ const timedOut = sample({
 });
 ```
 
-## `isAbortError`
-
-`AbortError` is thrown when the query is aborted.
-
-```ts
-import { isAbortError } from '@farfetched/core';
-
-const aborted = sample({
-  clock: query.finished.failure,
-  filter: isAbortError,
-});
-```
-
 ## `isPreparationError`
 
 Preparation error is thrown when the response cannot be prepared for some reason. For example, when the response is not a JSON string, but supposed to be.

apps/website/docs/releases/0-11.md

@@ -1,3 +1,9 @@
 # v0.11
 
+## Migration guide
+
+### Delete `isAbortError`
+
+Since [v0.10](/releases/0-10) aborted [_Queries_](/api/primitives/query) and [_Mutations_](/api/primitives/mutations) are not treated as failed anymore. So, `isAbortError` is not needed can be safely removed from your codebase.
+
 <!--@include: ./0-11.changelog.md-->

packages/core/index.ts

@@ -89,7 +89,6 @@ export {
 } from './src/errors/create_error';
 export {
   isTimeoutError,
-  isAbortError,
   isPreparationError,
   isHttpError,
   isNetworkError,

packages/core/src/errors/guards.ts

@@ -27,6 +27,12 @@ export function isTimeoutError(
   return args.error?.errorType === TIMEOUT;
 }
 
+/**
+ * Has to be private, do not export it.
+ * 
+ * Since Farfetcehd 0.10 aborted RemoteOperation is not considered as an error,
+ * so isAbortError is not needed anymore in userland.
+ */
 export function isAbortError(args: WithError): args is WithError<AbortError> {
   return args.error?.errorType === ABORT;
 }