Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

BaseMutationNarrowing.md

96 lines3.5 KB

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

Type Parameters

• TData = unknown

• TError = DefaultError

• TVariables = unknown

• TContext = unknown

Properties

isError()

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()

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()

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()

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