Class BaseRouteService`Abstract`

Base class for services to communicate with routes of the server application

Remarks

All requests will include a header with the player session id

Hierarchy (View Summary)

BaseRouteService
- GameRouteService

Index

Constructors

Properties

Methods

getJsonApi methodJsonApi postJsonApi

Constructors

constructor

new BaseRouteService(): BaseRouteService
Returns BaseRouteService

Properties

`Private`_playerService

_playerService: PlayerService = ...

Instance of the player service

Methods

`Protected`getJsonApi

getJsonApi<T1, T2 = unknown>(path: string, data?: T2): Promise<T1>
Perform a GET request and retrieve a JSON response
Type Parameters
- T1
  Return type of the function
- T2 = unknown
  Type of query string attributes
Parameters
- path: string
  Url to request
- Optionaldata: T2
  Optional object to use for the query string attributes
Returns Promise<T1>
JSON object of the response, otherwise undefined.
- Defined in src/web/src/services/BaseRouteService.ts:23

`Private`methodJsonApi

methodJsonApi<T1, T2 = unknown>(
    method: string,
    path: string,
    data?: T2,
): Promise<T1>
Perform any type of request and retrieve a JSON response
Type Parameters
- T1
  Return type of the function
- T2 = unknown
  Type of request body
Parameters
- method: string
  Method to use for the request
- path: string
  Url to request
- Optionaldata: T2
  Optional object to include in the body of the request
Returns Promise<T1>
JSON object of the response, otherwise undefined.
- Defined in src/web/src/services/BaseRouteService.ts:69

`Protected`postJsonApi

postJsonApi<T1, T2 = unknown>(path: string, data?: T2): Promise<T1>
Perform a POST request and retrieve a JSON response
Type Parameters
- T1
  Return type of the function
- T2 = unknown
  Type of request body
Parameters
- path: string
  Url to request
- Optionaldata: T2
  Optional object to include in the body of the request
Returns Promise<T1>
JSON object of the response, otherwise undefined.
- Defined in src/web/src/services/BaseRouteService.ts:53