Class MutationObserver<TData, TError, TVariables, TContext>

Type Parameters

  • TData = unknown

  • TError = unknown

  • TVariables = void

  • TContext = unknown

Hierarchy

Constructors

constructor

Properties

client currentMutation? currentResult listeners mutateOptions? notify options updateResult

Methods

bindMethods getCurrentResult hasListeners mutate onMutationUpdate onSubscribe onUnsubscribe reset setOptions subscribe

Constructors

constructor

  • new MutationObserver<TData, TError, TVariables, TContext>(client, options): MutationObserver<TData, TError, TVariables, TContext>

  • Type Parameters

    • TData = unknown

    • TError = unknown

    • TVariables = void

    • TContext = unknown

    Parameters

    Returns MutationObserver<TData, TError, TVariables, TContext>

Properties

Private client

client: any

Private Optional currentMutation

currentMutation?: any

Private currentResult

currentResult: any

Protected listeners

listeners: Set<{
    listener: MutationObserverListener<TData, TError, TVariables, TContext>;
}>

Type declaration

Private Optional mutateOptions

mutateOptions?: any

Private notify

notify: any

options

options: MutationObserverOptions<TData, TError, TVariables, TContext>

Private updateResult

updateResult: any

Methods

Protected bindMethods

  • bindMethods(): void

  • Returns void

getCurrentResult

  • getCurrentResult(): MutationObserverResult<TData, TError, TVariables, TContext>

  • Returns MutationObserverResult<TData, TError, TVariables, TContext>

hasListeners

  • hasListeners(): boolean

  • Returns boolean

mutate

  • mutate(variables?, options?): Promise<TData>

  • Parameters

    • Optional variables: TVariables
    • Optional options: MutateOptions<TData, TError, TVariables, TContext>

    Returns Promise<TData>

onMutationUpdate

  • onMutationUpdate(action): void

  • Parameters

    • action: Action<TData, TError, TVariables, TContext>

    Returns void

Protected onSubscribe

  • onSubscribe(): void

  • Returns void

Protected onUnsubscribe

  • onUnsubscribe(): void

  • Returns void

reset

  • reset(): void

  • Returns void

setOptions

  • setOptions(options?): void

  • Parameters

    Returns void

subscribe

  • subscribe(listener): (() => void)

  • Parameters

    Returns (() => void)

      • (): void

      • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc