Class LoadBalancerTypes

Load Balancers Types API

Load Balancers can be used to load balance traffic between multiple servers. https://docs.hetzner.cloud/#load-balancers

Hierarchy (View Summary)

BaseAPI
- LoadBalancerTypes

Index

Constructors

Properties

Methods

get list request

Constructors

constructor

new LoadBalancerTypes(token: string, baseUrl?: string): LoadBalancerTypes
Parameters
- token: string
- OptionalbaseUrl: string
Returns LoadBalancerTypes
Inherited from BaseAPI.constructor
- Defined in base.ts:7

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

get

get(
    id: number,
): Promise<
    | { response: { load_balancer_type: LoadBalancerType }; success: true }
    | { response: APIError; success: false },
>
Get a specific Load Balancer Type by ID
Parameters
- id: number
Returns Promise<
| { response: { load_balancer_type: LoadBalancerType }; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers-types.ts:43

list

list(
    params?: ListLoadBalancerTypesParams,
): Promise<
    | { response: LoadBalancerTypesResponse; success: true }
    | { response: APIError; success: false },
>
Gets all Load Balancer type objects.
Parameters
- Optionalparams: ListLoadBalancerTypesParams
Returns Promise<
| { response: LoadBalancerTypesResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers-types.ts:21

request

request<T>(
    endpoint: string,
    options?: RequestInit,
): Promise<
    { response: T; success: true }
    | { response: APIError; success: false },
>
Type Parameters
- T
Parameters
- endpoint: string
- options: RequestInit = {}
Returns Promise<{ response: T; success: true } | { response: APIError; success: false }>
Inherited from BaseAPI.request
- Defined in base.ts:12