Class: InstanceEndpoint

Defined in: endpoints/instance.ts:6

Constructors

Constructor

new InstanceEndpoint(client): InstanceEndpoint;

Defined in: endpoints/instance.ts:7

Parameters

Parameter	Type
client	RESTClient

Returns

InstanceEndpoint

Methods

getBeamWeather()

getBeamWeather(locationId?, config?): Promise<{
  success: boolean;
  weather: BeamWeather | null;
}>;

Defined in: endpoints/instance.ts:9

Parameters

Parameter	Type
locationId?	number
config?	AxiosRequestConfig<any, any>

Returns

Promise<{ success: boolean; weather: BeamWeather | null; }>

---

getLocalDetails()

getLocalDetails(): Promise<IInstanceDetailsResponse>;

Defined in: endpoints/instance.ts:36

get local instance details (public, unauthenticated) returns only the home instance this server represents

Returns

Promise<IInstanceDetailsResponse>

---

searchBeamLocations()

searchBeamLocations(
   countryCode, 
   name, 
   config?
): Promise<{
  locations: BeamLocation[];
  success: boolean;
}>;

Defined in: endpoints/instance.ts:20

Parameters

Parameter	Type
countryCode	string
name	string
config?	AxiosRequestConfig<any, any>

Returns

Promise<{ locations: BeamLocation[]; success: boolean; }>