eso-status/connector

eso-status/connector is a library for retrieving data from the eso-status.com API

Table of Contents

• How to get it ?
• How to use it ?
• Slugs list

How to get it ?

npm i @eso-status/connector

How to use it ?

Listen api socket for service status update

import { EsoStatusConnector } from '@eso-status/connector';
import { EsoStatus } from '@eso-status/types';

EsoStatusConnector.listen().on('statusUpdate', (esoStatus: EsoStatus): void => {
  ...
});

Listen api socket for service maintenance emitted

import { EsoStatusConnector } from '@eso-status/connector';
import { MaintenanceEsoStatus } from '@eso-status/types';

EsoStatusConnector.listen().on(
  'maintenancePlanned',
  (maintenanceEsoStatus: MaintenanceEsoStatus): void => {
    ...
  },
);

Listen api socket for service maintenance removed

import { EsoStatusConnector } from '@eso-status/connector';
import { Slug } from '@eso-status/types';

EsoStatusConnector.listen().on('maintenanceRemoved', (slug: Slug): void => {
  ...
});

Get status for specific slug

import { EsoStatusConnector } from '@eso-status/connector';
import { EsoStatus } from '@eso-status/types';

const esoStatus: EsoStatus = await EsoStatusConnector.get('server_pc_eu');

Get status for multi slugs

import { EsoStatusConnector } from '@eso-status/connector';
import { EsoStatus } from '@eso-status/types';

const esoStatusList: EsoStatus[] = await EsoStatusConnector.get([
  'server_pc_eu',
  'server_pc_na',
]);

Get status for all slugs

import { EsoStatusConnector } from '@eso-status/connector';
import { EsoStatus } from '@eso-status/types';

const esoStatusList: EsoStatus[] = await EsoStatusConnector.get();

Slugs list

Server/Service name	slug
XBOX NA	server_xbox_na
XBOX EU	server_xbox_eu
PlayStation NA	server_ps_na
PlayStation EU	server_ps_eu
PC NA	server_pc_na
PC EU	server_pc_eu
PTS	server_pc_pts
Web site	service_web_site
Official forum	service_web_forum
Web crown store	service_store_crown
In game crown store	service_store_eso
Account system	service_system_account