• Preparing search index...
  • The search index is not available
@squonk/data-manager-client
  • @squonk/data-manager-client
  • inventory/inventory
  • useGetUserInventory

Function useGetUserInventory

  • useGetUserInventory<
        TData = InventoryUserGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        params: undefined | GetUserInventoryParams,
        options: {
            query: Partial<
                UseQueryOptions<InventoryUserGetResponse, TError, TData>,
            > & Pick<
                DefinedInitialDataOptions<InventoryUserGetResponse, TError, TData>,
                "initialData",
            >;
            request?: AxiosRequestConfig;
        },
    ): DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

    • TData = InventoryUserGetResponse
    • TError = ErrorType<void | DmError>

    Parameters

    • params: undefined | GetUserInventoryParams
    • options: {
          query: Partial<UseQueryOptions<InventoryUserGetResponse, TError, TData>> & Pick<
              DefinedInitialDataOptions<InventoryUserGetResponse, TError, TData>,
              "initialData",
          >;
          request?: AxiosRequestConfig;
      }

    Returns DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }

    • Defined in src/inventory/inventory.ts:87
  • useGetUserInventory<
        TData = InventoryUserGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        params?: GetUserInventoryParams,
        options?: {
            query?: Partial<
                UseQueryOptions<InventoryUserGetResponse, TError, TData>,
            > & Pick<
                UndefinedInitialDataOptions<InventoryUserGetResponse, TError, TData>,
                "initialData",
            >;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

    • TData = InventoryUserGetResponse
    • TError = ErrorType<void | DmError>

    Parameters

    • Optionalparams: GetUserInventoryParams
    • Optionaloptions: {
          query?: Partial<
              UseQueryOptions<InventoryUserGetResponse, TError, TData>,
          > & Pick<
              UndefinedInitialDataOptions<InventoryUserGetResponse, TError, TData>,
              "initialData",
          >;
          request?: AxiosRequestConfig;
      }

    Returns UseQueryResult<TData, TError> & { queryKey: QueryKey }

    • Defined in src/inventory/inventory.ts:97
  • useGetUserInventory<
        TData = InventoryUserGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        params?: GetUserInventoryParams,
        options?: {
            query?: Partial<
                UseQueryOptions<InventoryUserGetResponse, TError, TData>,
            >;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

    • TData = InventoryUserGetResponse
    • TError = ErrorType<void | DmError>

    Parameters

    • Optionalparams: GetUserInventoryParams
    • Optionaloptions: {
          query?: Partial<
              UseQueryOptions<InventoryUserGetResponse, TError, TData>,
          >;
          request?: AxiosRequestConfig;
      }

    Returns UseQueryResult<TData, TError> & { queryKey: QueryKey }

    • Defined in src/inventory/inventory.ts:107

Settings

Member Visibility
@squonk/data-manager-client
  • Loading...

Generated using TypeDoc