main.react.query.queryObserver.core.kt Maven / Gradle / Ivy

Go to download
// Automatically generated - do not modify!

@file:JsModule("react-query")
@file:JsNonModule

@file:Suppress(
    "UNUSED_TYPEALIAS_PARAMETER",
    "NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)

package react.query

typealias QueryObserverListener = (result: QueryObserverResult) -> Unit

external interface NotifyOptions {
    var cache: Boolean
    var listeners: Boolean
    var onError: Boolean
    var onSuccess: Boolean
}

external interface ObserverFetchOptions : FetchOptions {
    var throwOnError: Boolean
}

open external class QueryObserver(
    client: QueryClient,
    options: QueryObserverOptions,
) : Subscribable> {
    open var options: QueryObserverOptions
    protected open fun bindMethods()
    override fun onSubscribe()
    override fun onUnsubscribe()
    open fun shouldFetchOnReconnect(): Boolean
    open fun shouldFetchOnWindowFocus(): Boolean
    open fun destroy()
    open fun setOptions(
        options: QueryObserverOptions = definedExternally,
        notifyOptions: NotifyOptions = definedExternally,
    )

    open fun getOptimisticResult(options: QueryObserverOptions): QueryObserverResult
    open fun getCurrentResult(): QueryObserverResult
    open fun trackResult(
        result: QueryObserverResult,
        defaultedOptions: QueryObserverOptions,
    ): QueryObserverResult

    open fun getNextResult(options: ResultOptions = definedExternally): kotlin.js.Promise>
    open fun getCurrentQuery(): Query
    open fun remove()
    open fun  refetch(options: RefetchOptions /* & RefetchQueryFilters */ = definedExternally): kotlin.js.Promise>
    open fun fetchOptimistic(options: QueryObserverOptions): kotlin.js.Promise>
    protected open fun fetch(fetchOptions: ObserverFetchOptions = definedExternally): kotlin.js.Promise>
    protected open fun createResult(
        query: Query,
        options: QueryObserverOptions,
    ): QueryObserverResult

    open fun updateResult(notifyOptions: NotifyOptions = definedExternally)
    open fun onQueryUpdate(action: Action)
}