BaseMutationNarrowing

Interface: BaseMutationNarrowing<TData, TError, TVariables, TContext>

Type Parameters

TData = unknown

TError = DefaultError

TVariables = unknown

TContext = unknown

Properties

isError()

ts
isError: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverErrorResult<TData, TError, TVariables, TContext>, Object> & Object>;
isError: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverErrorResult<TData, TError, TVariables, TContext>, Object> & Object>;

Parameters

this: CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<"error" | "success" | "pending" | "idle", TData, TError, TVariables, TContext>>

Returns

this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverErrorResult<TData, TError, TVariables, TContext>, Object> & Object>

Defined in

types.ts:248


isIdle()

ts
isIdle: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverIdleResult<TData, TError, TVariables, TContext>, Object> & Object>;
isIdle: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverIdleResult<TData, TError, TVariables, TContext>, Object> & Object>;

Parameters

this: CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<"error" | "success" | "pending" | "idle", TData, TError, TVariables, TContext>>

Returns

this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverIdleResult<TData, TError, TVariables, TContext>, Object> & Object>

Defined in

types.ts:278


isPending()

ts
isPending: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverLoadingResult<TData, TError, TVariables, TContext>, Object> & Object>;
isPending: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverLoadingResult<TData, TError, TVariables, TContext>, Object> & Object>;

Parameters

this: CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<"error" | "success" | "pending" | "idle", TData, TError, TVariables, TContext>>

Returns

this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverLoadingResult<TData, TError, TVariables, TContext>, Object> & Object>

Defined in

types.ts:263


isSuccess()

ts
isSuccess: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverSuccessResult<TData, TError, TVariables, TContext>, Object> & Object>;
isSuccess: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverSuccessResult<TData, TError, TVariables, TContext>, Object> & Object>;

Parameters

this: CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<"error" | "success" | "pending" | "idle", TData, TError, TVariables, TContext>>

Returns

this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverSuccessResult<TData, TError, TVariables, TContext>, Object> & Object>

Defined in

types.ts:233

Want to Skip the Docs?
Query.gg - The Official React Query Course
“This course is the best way to learn how to use React Query in real-world applications.”—Tanner Linsley
Get the course