Pokebag/data-sdk

View on GitHub
src/getHeldItems.js

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
// Local imports
import './models/HeldItem.js'
import { getEntities } from './api/index.js'





/**
 * Returns data for held items
 *
 * @memberof module:@pokebag/data-sdk
 * @param {Object} [options] An object containing filtering options
 * @param {string[]} [options.ids] Array of item IDs to be returned
 * @param {string} [options.patch] Maximum patch version to return data for
 *
 * @returns {Promise<HeldItem[]>} An array containing data for each item requested
 */
export async function getHeldItems(options) {
    return getEntities({
        ...options || {},
        type: 'held-items',
    })
}