Class SampQuery

Hierarchy

SampQuery

Index

Constructors

constructor

new SampQuery(options?: SampQueryOptions): SampQuery
Parameters
- options: SampQueryOptions = {}
Returns SampQuery
- Defined in src/query.ts:76

Properties

options

options: SampQueryOptions

Methods

getServer

getServer(options?: SampQueryOptions): Promise<{
    info: SampQueryInfoResult;
    players: SampQueryPlayersResult;
    rules: SampQueryRulesResult;
}>
Parameters
- options: SampQueryOptions = {}
Returns Promise<{
    info: SampQueryInfoResult;
    players: SampQueryPlayersResult;
    rules: SampQueryRulesResult;
}>
- Defined in src/query.ts:80

getServerInfo

getServerInfo(options?: SampQueryOptions): Promise<SampQueryInfoResult>
Parameters
- options: SampQueryOptions = {}
Returns Promise<SampQueryInfoResult>
- Defined in src/query.ts:92

getServerPing

getServerPing(options?: SampQueryOptions): Promise<number>
Parameters
- options: SampQueryOptions = {}
Returns Promise<number>
- Defined in src/query.ts:120

getServerPlayers

getServerPlayers(options?: SampQueryOptions): Promise<SampQueryPlayersResult>
Parameters
- options: SampQueryOptions = {}
Returns Promise<SampQueryPlayersResult>
- Defined in src/query.ts:106

getServerPlayersDetailed

getServerPlayersDetailed(options?: SampQueryOptions): Promise<SampQueryPlayersDetailedResult>
Parameters
- options: SampQueryOptions = {}
Returns Promise<SampQueryPlayersDetailedResult>
- Defined in src/query.ts:113

getServerRules

getServerRules(options?: SampQueryOptions): Promise<SampQueryRulesResult>
Parameters
- options: SampQueryOptions = {}
Returns Promise<SampQueryRulesResult>
- Defined in src/query.ts:99

request

request(opts: SampQueryRequestOptions<105>): Promise<SampQueryInfoResult>
Parameters
- opts: SampQueryRequestOptions<105>
Returns Promise<SampQueryInfoResult>
- Defined in src/query.ts:126
request(opts: SampQueryRequestOptions<114>): Promise<SampQueryRulesResult>
Parameters
- opts: SampQueryRequestOptions<114>
Returns Promise<SampQueryRulesResult>
- Defined in src/query.ts:127
request(opts: SampQueryRequestOptions<100>): Promise<SampQueryPlayersDetailedResult>
Parameters
- opts: SampQueryRequestOptions<100>
Returns Promise<SampQueryPlayersDetailedResult>
- Defined in src/query.ts:128
request(opts: SampQueryRequestOptions<99>): Promise<SampQueryPlayersResult>
Parameters
- opts: SampQueryRequestOptions<99>
Returns Promise<SampQueryPlayersResult>
- Defined in src/query.ts:129

Class SampQuery

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: SampQueryOptions = {}

Returns SampQuery

Properties

options

Methods

getServer

Parameters

options: SampQueryOptions = {}

Returns Promise<{ info: SampQueryInfoResult; players: SampQueryPlayersResult; rules: SampQueryRulesResult; }>

getServerInfo

Parameters

options: SampQueryOptions = {}

Returns Promise<SampQueryInfoResult>

getServerPing

Parameters

options: SampQueryOptions = {}

Returns Promise<number>

getServerPlayers

Parameters

options: SampQueryOptions = {}

Returns Promise<SampQueryPlayersResult>

getServerPlayersDetailed

Parameters

options: SampQueryOptions = {}

Returns Promise<SampQueryPlayersDetailedResult>

getServerRules

Parameters

options: SampQueryOptions = {}

Returns Promise<SampQueryRulesResult>

request

Parameters

opts: SampQueryRequestOptions<105>

Returns Promise<SampQueryInfoResult>

Parameters

opts: SampQueryRequestOptions<114>

Returns Promise<SampQueryRulesResult>

Parameters

opts: SampQueryRequestOptions<100>

Returns Promise<SampQueryPlayersDetailedResult>

Parameters

opts: SampQueryRequestOptions<99>

Returns Promise<SampQueryPlayersResult>

Settings

Member Visibility

Theme

Returns Promise<{
info: SampQueryInfoResult;
players: SampQueryPlayersResult;
rules: SampQueryRulesResult;
}>