@qbcart/eshop-inventory-hooks
Version:
Types to hooks for querying inventory data from LocalDB.
17 lines (16 loc) • 664 B
TypeScript
/**
* @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 an inventory item from LocalDB.
* @param {string} id - The id of the inventory item to be used.
* @return The item to be used and a state function for changing the item to be used.
*/
declare const useInventoryItem: (id: string) => [ItemInventory | undefined, Dispatch<SetStateAction<string>>];
export default useInventoryItem;