@qbcart/eshop-inventory-hooks/hooks/useInventory.d.ts

Types to hooks for querying inventory data from LocalDB.

/**
 * @license
 * Copyright (c) 2021 QBCart Inc. All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source repo.
 */
import { Dispatch, SetStateAction } from 'react';
import type { ItemInventory } from '@qbcart/types';
/**
 * Hook for retrieving inventory items from LocalDB.
 * @param {string[]} ids - (optional) Array of ids by which to filter the inventory items to be used.
 * @return An array of inventory items to be used and a function for filtering the items to be used.
 */
declare const useInventory: (ids?: string[] | undefined) => [ItemInventory[], Dispatch<SetStateAction<string[] | undefined>>];
export default useInventory;