esijs/src/dogma.js

A simple module for ESI.

const { request, inputValidation } = require('./util/util.js')

module.exports = {
    /**
     * Get information on a dogma attribute.
     * @param {number} attr
     * @returns {Promise<object>} Info on the attribute.
     */
    attrInfo(attribute) {
        inputValidation({
            input: attribute,
            type: 'number',
            message: `The function 'dogma.attrInfo' requires an attribute!`,
        })

        return request({
            subUrl: `dogma/attributes/${attribute}`,
        })
    },
    /**
     * Get a list of dogma attribute ids.
     * @returns {Promise<[number]>} A array of all attributes.
     */
    attrs() {
        return request({
            subUrl: `dogma/attributes`,
        })
    },
    /**
     * Returns info about a dynamic item resulting from mutation with a mutaplasmid.
     * @param {number} itemID
     * @param {number} typeID
     * @returns {Promise<object>} Info on the mutation.
     */
    dynamicItemInfo(itemID, typeID) {
        inputValidation({
            input: itemID,
            type: 'number',
            message: `The function 'dogma.attrs' requires an attribute!`,
        })
        inputValidation({
            input: typeID,
            type: 'number',
            message: `The function 'dogma.attrs' requires an typeID!`,
        })

        return request({
            subUrl: `dogma/dynamic/items/${typeID}/${itemID}`,
        })
    },
    /**
     * Get information on a dogma effect.
     * @param {number} effect
     * @returns {Promise<object>} Info on the effect.
     */
    effectInfo(effect) {
        inputValidation({
            input: effect,
            type: 'number',
            message: `The function 'dogma.effectInfo' requires a effect ID!`,
        })

        return request({
            subUrl: `dogma/effects/${effect}`,
        })
    },
    /**
     * Get a list of dogma effect ids.
     * @returns {Promise<[number]>} A array of dogma effects.
     */
    effects() {
        return request({
            subUrl: `dogma/effects`,
        })
    },
}