Interface ItemSearchRequestOptions
allowCache?: boolean;
apiKey?: string;
cacheFor?: number;
category?: ItemCategory;
color?: number[];
displayName?: string;
dropType?: ItemDropType;
identifications?: IdentificationQuery;
ignoreVersion?: boolean;
lore?: string;
majorIds?: MajorIdQuery;
name?: string;
priority?: boolean;
requirements?: ItemRequirementQuery;
restriction?: ItemRestriction;
retries?: number;
set?: string;
sprite?: SpriteQuery | MinecraftId;
stats?: ItemStatQuery;
tier?: ItemRarity;
timeout?: number;
type?: ItemType;
}
Hierarchy
- RequestOptions
- ItemSearchRequestOptions
Properties
Optional allow
Whether to allow this request to use the cache or ongoing requests if available
Requests using cache or other requests do not count towards the ratelimit and return a lot faster.
Optional api
The API key to use in this request
The key has to be registered in the config.
If this is not given, the registered key with the most free requests will be selected.
Optional cache
The amount of time the request should be cached for, overwrites the defaults specified in the config
Optional category
Only match items of this category
Optional color
Only match items using this color
The array must be of length 3 and contain only integers between 0 and 255.
Optional display
Only match items containing this string in their displayName
@case-insensitive
Optional drop
Only match items obtained from this source
Optional identifications
Only match items that match the identification query
Optional ignore
Whether to ignore version errors
You can use this to resolve temporary conflicts while the library awaits being updated. Otherwise it should stay enabled.
Default
false
Optional lore
Only match items containing this string in their lore @case-insensitive
Optional major
Only match items that match the major ID query
Optional name
Only match items containing this string in their name
Use the displayName filter for names as shown in-game.
Optional priority
Whether this request should be put to the front of the queue, executing before any non-priority requests are handled
Default
false
Optional requirements
Only match items that match the requirement query
Optional restriction
Only match items with this restriction
Use null to search for items without any restrictions.
Optional retries
The amount of times to retry the request on error
Optional set
Only match items that are part of this set
This property is currently only used by the `LEAF` set.
Optional sprite
Only match items using this visual sprite
Optional stats
Only match items that match the stat query
Optional tier
Only match items of this Rarity
Optional timeout
The amount of milliseconds a until the request should be rejected
Optional type
Only match items of this type
The options for an item API request