mirror of https://github.com/apache/druid.git
73 lines
2.5 KiB
TypeScript
73 lines
2.5 KiB
TypeScript
/*
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
* or more contributor license agreements. See the NOTICE file
|
|
* distributed with this work for additional information
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
* to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { useEffect, useState } from 'react';
|
|
|
|
import { QueryManager, QueryManagerOptions, QueryState } from '../utils';
|
|
|
|
import { useConstant } from './use-constant';
|
|
import { usePermanentCallback } from './use-permanent-callback';
|
|
|
|
export interface UseQueryManagerOptions<Q, R, I, E extends Error>
|
|
extends Omit<QueryManagerOptions<Q, R, I, E>, 'onStateChange'> {
|
|
query?: Q | undefined;
|
|
initQuery?: Q;
|
|
}
|
|
|
|
export function useQueryManager<Q, R, I = never, E extends Error = Error>(
|
|
options: UseQueryManagerOptions<Q, R, I, E>,
|
|
): [QueryState<R, E, I>, QueryManager<Q, R, I, E>] {
|
|
const { query, initQuery, initState, processQuery, backgroundStatusCheck } = options;
|
|
|
|
const concreteProcessQuery = usePermanentCallback(processQuery);
|
|
const concreteBackgroundStatusCheck = usePermanentCallback(
|
|
backgroundStatusCheck || ((() => {}) as any),
|
|
);
|
|
|
|
const [resultState, setResultState] = useState<QueryState<R, E, I>>(initState || QueryState.INIT);
|
|
|
|
const queryManager = useConstant(() => {
|
|
return new QueryManager<Q, R, I, E>({
|
|
...options,
|
|
initState,
|
|
processQuery: concreteProcessQuery,
|
|
backgroundStatusCheck: backgroundStatusCheck ? concreteBackgroundStatusCheck : undefined,
|
|
onStateChange: setResultState,
|
|
});
|
|
});
|
|
|
|
useEffect(() => {
|
|
if (typeof initQuery !== 'undefined') {
|
|
queryManager.runQuery(initQuery);
|
|
}
|
|
return () => {
|
|
queryManager.terminate();
|
|
};
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
}, []);
|
|
|
|
useEffect(() => {
|
|
if (typeof query !== 'undefined') {
|
|
queryManager.runQuery(query);
|
|
}
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
}, [query]);
|
|
|
|
return [resultState, queryManager];
|
|
}
|