esijs
Version:
A simple module for ESI.
69 lines (44 loc) • 1.52 kB
Markdown
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [attrInfo][1]
- [Parameters][2]
- [attrs][3]
- [dynamicItemInfo][4]
- [Parameters][5]
- [effectInfo][6]
- [Parameters][7]
- [effects][8]
## attrInfo
Get information on a dogma attribute.
### Parameters
- `attribute`  
- `attr` **[number][9]** 
Returns **[Promise][10]<[object][11]>** Info on the attribute.
## attrs
Get a list of dogma attribute ids.
Returns **[Promise][10]<\[[number][9]]>** A array of all attributes.
## dynamicItemInfo
Returns info about a dynamic item resulting from mutation with a mutaplasmid.
### Parameters
- `itemID` **[number][9]** 
- `typeID` **[number][9]** 
Returns **[Promise][10]<[object][11]>** Info on the mutation.
## effectInfo
Get information on a dogma effect.
### Parameters
- `effect` **[number][9]** 
Returns **[Promise][10]<[object][11]>** Info on the effect.
## effects
Get a list of dogma effect ids.
Returns **[Promise][10]<\[[number][9]]>** A array of dogma effects.
[1]: #attrinfo
[2]: #parameters
[3]: #attrs
[4]: #dynamiciteminfo
[5]: #parameters-1
[6]: #effectinfo
[7]: #parameters-2
[8]: #effects
[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object