warframe-worldstate-parser
Version:
An Open parser for Warframe's Worldstate in Javascript
57 lines (56 loc) • 1.94 kB
TypeScript
/**
* Represents a syndicate daily mission
* @augments {WorldstateObject}
*/
export default class SyndicateMission extends WorldstateObject {
/**
* Build a new SyndicateMission with async operations & data
* @param {object} data The syndicate mission data
* @param {object} deps The dependencies object
* @param {string} deps.locale Locale to use for translations
* @returns {Promise.<SyndicateMission>} SyndicateMission object w/ async resolution of jobs
*/
static build(data: object, deps: {
locale: string;
}): Promise<SyndicateMission>;
/**
* @param {object} data The syndicate mission data
* @param {object} deps The dependencies object
* @param {string} deps.locale Locale to use for translations
*/
constructor(data: object, { locale }?: {
locale: string;
});
/**
* The syndicate that is offering the mission
* @type {string}
*/
syndicate: string;
/**
* The syndicate that is offering the mission
* @type {string}
*/
syndicateKey: string;
/**
* The nodes on which the missions are taking place
* @type {Array.<string>}
*/
nodes: Array<string>;
/**
* The jobs for this syndicate. Will normally be []
* @type {Array.<SyndicateJob>}
*/
jobs: Array<SyndicateJob>;
/**
* ETA string (at time of object creation)
* @type {string} time delta string from now to the expiry
*/
eta: string;
/**
* Get a string indicating how much time is left before the syndicate mission expries
* @returns {string} time delta string from now to the expiry
*/
getETAString(): string;
}
import WorldstateObject from './WorldstateObject.js';
import SyndicateJob from './SyndicateJob.js';