Interface IngredientSearchRequestOptions

The options for an ingredient API request

interface IngredientSearchRequestOptions {
    allowCache?: boolean;
    apiKey?: string;
    cacheFor?: number;
    displayName?: string;
    identifications?: IdentificationQuery;
    ignoreVersion?: boolean;
    level?: number | OpenRange;
    name?: string;
    positionModifiers?: PositionModifierQuery;
    priority?: boolean;
    restrictedIds?: RestrictedIdQuery;
    retries?: number;
    skills?: CraftingSkillQuery;
    sprite?: SpriteQuery | MinecraftId;
    tier?: number | OpenRange;
    timeout?: number;
}

Hierarchy

Properties

allowCache? apiKey? cacheFor? displayName? identifications? ignoreVersion? level? name? positionModifiers? priority? restrictedIds? retries? skills? sprite? tier? timeout?

Properties

Optional allowCache

allowCache?: boolean

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 apiKey

apiKey?: string

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 cacheFor

cacheFor?: number

The amount of time the request should be cached for, overwrites the defaults specified in the config

Optional displayName

displayName?: string

Only match ingredients containing this string in their name as displayed in-game @case-insensitive

Optional identifications

identifications?: IdentificationQuery

Only match ingredients with these identifications

Optional ignoreVersion

ignoreVersion?: boolean

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

level?: number | OpenRange

Only match ingredients of this level

Values have to be integers and the Range has to have at least one bound.

Optional name

name?: string

Only match ingredients containing this string in their name @case-insensitive

Optional positionModifiers

positionModifiers?: PositionModifierQuery

Only match ingredients with these positional modifiers

Optional priority

priority?: boolean

Whether this request should be put to the front of the queue, executing before any non-priority requests are handled

Default

false

Optional restrictedIds

restrictedIds?: RestrictedIdQuery

Only match ingredients with these restricted identifications

Optional retries

retries?: number

The amount of times to retry the request on error

Optional skills

skills?: CraftingSkillQuery

Only match ingredients that match this Filter

Optional sprite

sprite?: SpriteQuery | MinecraftId

Only match ingredients using this sprite

Optional tier

tier?: number | OpenRange

Only match ingredients of this tier

Values have to be integers between 0 and 3 and the Range has to have at least one bound.

Optional timeout

timeout?: number

The amount of milliseconds a until the request should be rejected

Be aware that each retry has it's own timeout, meaning 30,000 ms of timeout may lead to a 90,000 ms wait until a request is rejected on 2 retries.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc