Class RouterConfig

Hierarchy

default
- RouterConfig

Index

Constructors

Properties

baseUrl client_id client_secret

Accessors

accountNumber config configId nickname

Methods

delete get paginate post put save toString disconnect

Constructors

constructor

new RouterConfig(
    client_id: string,
    client_secret: string,
    routerConfig: Starlink.Management.Response.RouterConfig,
): RouterConfig
Parameters
- client_id: string
- client_secret: string
- routerConfig: Starlink.Management.Response.RouterConfig
Returns RouterConfig
Overrides BaseAPI.constructor

Properties

`Readonly`baseUrl

baseUrl: "https://starlink.com/api/public" = 'https://starlink.com/api/public'

`Readonly`client_id

client_id: string

`Protected` `Readonly`client_secret

client_secret: string

Accessors

accountNumber

get accountNumber(): string
Returns string

config

get config(): any
Returns any
set config(value: any): void
Parameters
- value: any
Returns void

configId

get configId(): string
Returns string

nickname

get nickname(): string
Returns string
set nickname(value: string): void
Parameters
- value: string
Returns void

Methods

`Protected`delete

delete<Type extends Starlink.Response = any>(
endpoint: string,
params?: Record<string, any>,
): Promise<Type>
Protected
Performs an HTTP delete request against the Starlink Enterprise API
Type Parameters
- Type extends Starlink.Response = any
Parameters
- endpoint: string
- params: Record<string, any> = {}
Returns Promise<Type>
Inherited from BaseAPI.delete

`Protected`get

get<Type extends Starlink.Response = any>(
endpoint: string,
params?: Record<string, any>,
): Promise<Type>
Protected
Performs an HTTP get request against the Starlink Enterprise API
Type Parameters
- Type extends Starlink.Response = any
Parameters
- endpoint: string
- params: Record<string, any> = {}
Returns Promise<Type>
Inherited from BaseAPI.get

`Protected`paginate

paginate<Record_>(
    method: "GET" | "POST",
    endpoint: string,
    opts?: Partial<
        {
            all: boolean;
            body: object;
            filters: Record<string, any>;
            page: number;
        },
    >,
): Promise<Record_[]>
Protected
Walks a paginated endpoint, returning every record.

When all: false, fetches the single page given by page and returns its results. When all: true (default), walks pages until isLastPage, asserting that the total received matches totalCount from the wire response.
Type Parameters
- Record_
Parameters
- method: "GET" | "POST"
- endpoint: string
- opts: Partial<
      {
          all: boolean;
          body: object;
          filters: Record<string, any>;
          page: number;
      },
  > = {}
Returns Promise<Record_[]>
Inherited from BaseAPI.paginate

`Protected`post

post<Type extends Starlink.Response = any>(
    endpoint: string,
    payload?: object,
    params?: Record<string, any>,
): Promise<Type>
Protected
Performs an HTTP post request against the Starlink Enterprise API
Type Parameters
- Type extends Starlink.Response = any
Parameters
- endpoint: string
- Optionalpayload: object
- params: Record<string, any> = {}
Returns Promise<Type>
Inherited from BaseAPI.post

`Protected`put

put<Type extends Starlink.Response = any>(
endpoint: string,
payload?: string | object,
): Promise<Type>
Protected
Performs an HTTP put request against the Starlink Enterprise API
Type Parameters
- Type extends Starlink.Response = any
Parameters
- endpoint: string
- Optionalpayload: string | object
Returns Promise<Type>
Inherited from BaseAPI.put

save

save(): Promise<boolean>
Update the router configuration

Any router assigned to this configuration will immediately receive the updated if they are online. If it is not online, the router will receive the update when it comes online.

Returns Promise<boolean>

toString

toString(): string
Converts the instance to a string (JSON encoded)

Returns string

`Static`disconnect

disconnect(): Promise<void>
Disconnects the internal rate-limit cache and releases its resources

Returns Promise<void>
Inherited from BaseAPI.disconnect