Interface RecipeSearchRequestOptions
allowCache?: boolean;
apiKey?: string;
basicDuration?: OpenRange;
cacheFor?: number;
category?: ItemCategory;
damage?: OpenRange;
durability?: OpenRange;
duration?: OpenRange;
health?: OpenRange;
id?: string;
ignoreVersion?: boolean;
level?: number | OpenRange;
priority?: boolean;
retries?: number;
skill?: CraftingSkill;
timeout?: number;
type?: CraftableItemType;
}
Hierarchy
- RequestOptions
- RecipeSearchRequestOptions
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 basic
Only match recipes if their basic duration lies within this range
Values have to be integer, and Ranges have to have at least one bound.
Optional cache
The amount of time the request should be cached for, overwrites the defaults specified in the config
Optional category
Only match recipes of this item category
Optional damage
Only match recipes if their damage lies within this range
Values have to be integer, and Ranges have to have at least one bound.
Optional durability
Only match recipes if their durability lies within this range
Values have to be integer, and Ranges have to have at least one bound.
Optional duration
Only match recipes if their duration lies within this range
Values have to be integer, and Ranges have to have at least one bound.
Optional health
Only match recipes if their health lies within this range
Values have to be integer, and Ranges have to have at least one bound.
Optional id
Only match the recipe with this ID
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 level
Only match recipes within this level range
Values have to be integer, and Ranges have to have at least one bound.
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 retries
The amount of times to retry the request on error
Optional skill
Only match recipes using this crafting skill
Optional timeout
The amount of milliseconds a until the request should be rejected
Optional type
Only match recipes of this item type
The options for a recipe API request