diff --git a/classes/AccountCreationFailed.html b/classes/AccountCreationFailed.html index 15a3e26..b7e56f5 100644 --- a/classes/AccountCreationFailed.html +++ b/classes/AccountCreationFailed.html @@ -25,7 +25,7 @@

Hierarchy

+
  • Defined in src/types.ts:866
    • @@ -64,7 +64,7 @@
    notice: string

    Returns AccountCreationFailed

    +
  • Defined in src/types.ts:867

    • Properties

    diff --git a/classes/AmbiguousDeleteBanRequest.html b/classes/AmbiguousDeleteBanRequest.html index 35abf0d..c965b9f 100644 --- a/classes/AmbiguousDeleteBanRequest.html +++ b/classes/AmbiguousDeleteBanRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    +
  • Defined in src/types.ts:1041
    • @@ -54,7 +54,7 @@

    constructorReturns AmbiguousDeleteBanRequest

    +
  • Defined in src/types.ts:1042

    • Properties

    diff --git a/classes/AuthenticationRequired.html b/classes/AuthenticationRequired.html index 8d70297..d955848 100644 --- a/classes/AuthenticationRequired.html +++ b/classes/AuthenticationRequired.html @@ -28,7 +28,7 @@

    Hierarchy

    +
  • Defined in src/types.ts:901
    • @@ -60,7 +60,7 @@

    constructorReturns AuthenticationRequired

    +
  • Defined in src/types.ts:902

    • Properties

    diff --git a/classes/Banlist.html b/classes/Banlist.html index c4d2b05..0300af6 100644 --- a/classes/Banlist.html +++ b/classes/Banlist.html @@ -18,7 +18,7 @@

    Hierarchy

    +
  • Defined in src/types.ts:641
    • @@ -38,7 +38,7 @@

    Properties

    Readonly id

    id: string
    +
  • Defined in src/types.ts:642

    • Methods

    @@ -53,7 +53,7 @@

    Parameters

    guid: string

    Returns Banlist

    +
  • Defined in src/types.ts:645
    • diff --git a/classes/BattlEyeGUID.html b/classes/BattlEyeGUID.html index 3eaa279..a919e0a 100644 --- a/classes/BattlEyeGUID.html +++ b/classes/BattlEyeGUID.html @@ -22,7 +22,7 @@

    Implements

    +
  • Defined in src/types.ts:352
    • @@ -46,7 +46,7 @@

    Properties

    Readonly guid

    guid: string
    +
  • Defined in src/types.ts:353

    • Accessors

    @@ -57,7 +57,7 @@

    idReturns string

    +
  • Defined in src/types.ts:356

    • Methods

    @@ -72,7 +72,7 @@

    Parameters

    guid: string

    Returns BattlEyeGUID

    +
  • Defined in src/types.ts:360
    • diff --git a/classes/BearerAuthorization.html b/classes/BearerAuthorization.html index 6f65fe1..5e7188e 100644 --- a/classes/BearerAuthorization.html +++ b/classes/BearerAuthorization.html @@ -22,7 +22,7 @@

    Implements

    +
  • Defined in src/types.ts:259
    • @@ -68,29 +68,29 @@
    created: Date
    expiresAt: Date

    Returns BearerAuthorization

    +
  • Defined in src/types.ts:265

    • Properties

    Readonly created

    created: Date
    +
  • Defined in src/types.ts:265

    • Readonly expiresAt

    expiresAt: Date
    +
  • Defined in src/types.ts:265

    • Readonly token

    token: string
    +
  • Defined in src/types.ts:265

    • Readonly type

    type: AuthorizationType
    +
  • Defined in src/types.ts:265

    • Methods

    @@ -101,7 +101,7 @@

    asHeaderReturns Record<string, undefined | string | string[]>

    +
  • Defined in src/types.ts:268

    • throwExpired

    Returns TokenExpired

    +
  • Defined in src/types.ts:274
    • diff --git a/classes/BohemiaInteractiveId.html b/classes/BohemiaInteractiveId.html index 32b5f99..3ab1a5b 100644 --- a/classes/BohemiaInteractiveId.html +++ b/classes/BohemiaInteractiveId.html @@ -22,7 +22,7 @@

    Implements

    +
  • Defined in src/types.ts:374
    • @@ -43,7 +43,7 @@

    Readonlyid: string

    +
  • Defined in src/types.ts:375

    • Methods

    @@ -58,7 +58,7 @@

    Parameters

    id: string

    Returns BohemiaInteractiveId

    +
  • Defined in src/types.ts:378
    • diff --git a/classes/CFToolsClientBuilder.html b/classes/CFToolsClientBuilder.html index 1d4f9ef..1f424d1 100644 --- a/classes/CFToolsClientBuilder.html +++ b/classes/CFToolsClientBuilder.html @@ -18,7 +18,7 @@

    Hierarchy

    • CFToolsClientBuilder
    +
  • Defined in src/internal/builder.ts:10
    • @@ -55,7 +55,7 @@

    build

    Returns CFToolsClient

    +
  • Defined in src/internal/builder.ts:106

    • withCache

      @@ -68,7 +68,7 @@

      Parameters

      Optional cache: Cache

    Returns CFToolsClientBuilder

    +
  • Defined in src/internal/builder.ts:64

    • withCacheConfiguration

    Returns CFToolsClientBuilder

    +
  • Defined in src/internal/builder.ts:98

    • withCredentials

    Returns CFToolsClientBuilder

    +
  • Defined in src/internal/builder.ts:59

    • withEnterpriseApi

    Returns CFToolsClientBuilder

    +
  • Defined in src/internal/builder.ts:48

    • withHttpClient

    Returns CFToolsClientBuilder

    +
  • Defined in src/internal/builder.ts:86

    • withServerApiId

    Returns CFToolsClientBuilder

    +
  • Defined in src/internal/builder.ts:36
    • diff --git a/classes/CFToolsId.html b/classes/CFToolsId.html index a430a6a..bf22108 100644 --- a/classes/CFToolsId.html +++ b/classes/CFToolsId.html @@ -22,7 +22,7 @@

    Implements

    +
  • Defined in src/types.ts:383
    • @@ -43,7 +43,7 @@

    Readonlyid: string

    +
  • Defined in src/types.ts:384

    • Methods

    @@ -58,7 +58,7 @@

    Parameters

    id: string

    Returns CFToolsId

    +
  • Defined in src/types.ts:387
    • diff --git a/classes/CFToolsUnavailable.html b/classes/CFToolsUnavailable.html index a3f588d..4e54a8e 100644 --- a/classes/CFToolsUnavailable.html +++ b/classes/CFToolsUnavailable.html @@ -26,7 +26,7 @@

    Hierarchy

    • CFToolsUnavailable
    +
  • Defined in src/types.ts:972
    • @@ -63,7 +63,7 @@
    url: string

    Returns CFToolsUnavailable

    +
  • Defined in src/types.ts:973

    • Properties

    diff --git a/classes/DuplicateResourceCreation.html b/classes/DuplicateResourceCreation.html index f999b9c..dce434c 100644 --- a/classes/DuplicateResourceCreation.html +++ b/classes/DuplicateResourceCreation.html @@ -28,7 +28,7 @@

    Hierarchy

    • DuplicateResourceCreation
    +
  • Defined in src/types.ts:938
    • @@ -65,7 +65,7 @@
    url: string

    Returns DuplicateResourceCreation

    +
  • Defined in src/types.ts:939

    • Properties

    diff --git a/classes/EnterpriseAuthorization.html b/classes/EnterpriseAuthorization.html index f2fd7b5..106b36e 100644 --- a/classes/EnterpriseAuthorization.html +++ b/classes/EnterpriseAuthorization.html @@ -22,7 +22,7 @@

    Implements

    +
  • Defined in src/types.ts:284
    • @@ -44,7 +44,7 @@

    asHeaderReturns Record<string, undefined | string | string[]>

    +
  • Defined in src/types.ts:292

    • throwExpired

    Returns TokenExpired

    +
  • Defined in src/types.ts:298

    • Static from

    Returns EnterpriseAuthorization

    +
  • Defined in src/types.ts:288
    • diff --git a/classes/GameServerQueryError.html b/classes/GameServerQueryError.html index ec8ee9e..fe0c2ee 100644 --- a/classes/GameServerQueryError.html +++ b/classes/GameServerQueryError.html @@ -26,7 +26,7 @@

    Hierarchy

    • GameServerQueryError
    +
  • Defined in src/types.ts:1034
    • @@ -63,7 +63,7 @@
    type: string

    Returns GameServerQueryError

    +
  • Defined in src/types.ts:1035

    • Properties

    diff --git a/classes/GrantRequired.html b/classes/GrantRequired.html index 8edbfd0..1c9b9f3 100644 --- a/classes/GrantRequired.html +++ b/classes/GrantRequired.html @@ -26,7 +26,7 @@

    Hierarchy

    • GrantRequired
    +
  • Defined in src/types.ts:983
    • @@ -63,7 +63,7 @@
    url: string

    Returns GrantRequired

    +
  • Defined in src/types.ts:984

    • Properties

    diff --git a/classes/IPAddress.html b/classes/IPAddress.html index 28f2026..3c7e79c 100644 --- a/classes/IPAddress.html +++ b/classes/IPAddress.html @@ -22,7 +22,7 @@

    Implements

    +
  • Defined in src/types.ts:396
    • @@ -44,12 +44,12 @@

    Readonlyid: string

    +
  • Defined in src/types.ts:397

    • Readonly type

    type: IPAddressType
    +
  • Defined in src/types.ts:397

    • Methods

    @@ -64,7 +64,7 @@

    Parameters

    address: string

    Returns IPAddress

    +
  • Defined in src/types.ts:400
    • diff --git a/classes/InvalidCredentials.html b/classes/InvalidCredentials.html index 498289d..5a98178 100644 --- a/classes/InvalidCredentials.html +++ b/classes/InvalidCredentials.html @@ -26,7 +26,7 @@

    Hierarchy

    • InvalidCredentials
    +
  • Defined in src/types.ts:889
    • @@ -58,7 +58,7 @@

    constructorReturns InvalidCredentials

    +
  • Defined in src/types.ts:890

    • Properties

    diff --git a/classes/LoginCredentials.html b/classes/LoginCredentials.html index 307fb43..64d0f61 100644 --- a/classes/LoginCredentials.html +++ b/classes/LoginCredentials.html @@ -22,7 +22,7 @@

    Hierarchy

    • LoginCredentials
    +
  • Defined in src/types.ts:339
    • @@ -43,12 +43,12 @@

    Properties

    Readonly applicationId

    applicationId: string
    +
  • Defined in src/types.ts:340

    • Readonly secret

    secret: string
    +
  • Defined in src/types.ts:340

    • Methods

    @@ -65,7 +65,7 @@
    applicationId: string
    secret: string

    Returns LoginCredentials

    +
  • Defined in src/types.ts:343
    • diff --git a/classes/RequestForbidden.html b/classes/RequestForbidden.html index c963746..10d9ef0 100644 --- a/classes/RequestForbidden.html +++ b/classes/RequestForbidden.html @@ -27,7 +27,7 @@

    Hierarchy

    • RequestForbidden
    +
  • Defined in src/types.ts:995
    • @@ -64,7 +64,7 @@
    message: string

    Returns RequestForbidden

    +
  • Defined in src/types.ts:996

    • Properties

    @@ -72,7 +72,7 @@

    Readonlymessage: string

    +
  • Defined in src/types.ts:996

    • name

    name: string
    +
  • Defined in src/types.ts:924
    • @@ -63,7 +63,7 @@
    url: string

    Returns RequestLimitExceeded

    +
  • Defined in src/types.ts:925

    • Properties

    diff --git a/classes/ResourceNotConfigured.html b/classes/ResourceNotConfigured.html index 51d166e..1279fa6 100644 --- a/classes/ResourceNotConfigured.html +++ b/classes/ResourceNotConfigured.html @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/types.ts:878
    • @@ -64,7 +64,7 @@
    resource: string
    Returns ResourceNotConfigured
    +
  • Defined in src/types.ts:879

    • Properties

    diff --git a/classes/ResourceNotFound.html b/classes/ResourceNotFound.html index 0ffc4b7..4ff5112 100644 --- a/classes/ResourceNotFound.html +++ b/classes/ResourceNotFound.html @@ -26,7 +26,7 @@

    Hierarchy

    +
  • Defined in src/types.ts:856
    • @@ -63,7 +63,7 @@
    url: string

    Returns ResourceNotFound

    +
  • Defined in src/types.ts:857

    • Properties

    diff --git a/classes/ServerApiId.html b/classes/ServerApiId.html index 3df8896..0e6906d 100644 --- a/classes/ServerApiId.html +++ b/classes/ServerApiId.html @@ -22,7 +22,7 @@

    Hierarchy

    +
  • Defined in src/types.ts:326
    • @@ -42,7 +42,7 @@

    Properties

    Readonly id

    id: string
    +
  • Defined in src/types.ts:327

    • Methods

    @@ -57,7 +57,7 @@

    Parameters

    id: string

    Returns ServerApiId

    +
  • Defined in src/types.ts:330
    • diff --git a/classes/ServerApiIdRequired.html b/classes/ServerApiIdRequired.html index 4335112..671362f 100644 --- a/classes/ServerApiIdRequired.html +++ b/classes/ServerApiIdRequired.html @@ -27,7 +27,7 @@

    Hierarchy

    • ServerApiIdRequired
    +
  • Defined in src/types.ts:913
    • @@ -59,7 +59,7 @@

    constructorReturns ServerApiIdRequired

    +
  • Defined in src/types.ts:914

    • Properties

    diff --git a/classes/SteamId64.html b/classes/SteamId64.html index a228214..240b1cc 100644 --- a/classes/SteamId64.html +++ b/classes/SteamId64.html @@ -22,7 +22,7 @@

    Implements

    +
  • Defined in src/types.ts:365
    • @@ -43,7 +43,7 @@

    Readonlyid: string

    +
  • Defined in src/types.ts:366

    • Methods

    @@ -58,7 +58,7 @@

    Parameters

    id: string

    Returns SteamId64

    +
  • Defined in src/types.ts:369
    • diff --git a/classes/TimeoutError.html b/classes/TimeoutError.html index d874313..3e8621a 100644 --- a/classes/TimeoutError.html +++ b/classes/TimeoutError.html @@ -26,7 +26,7 @@

    Hierarchy

    • TimeoutError
    +
  • Defined in src/types.ts:961
    • @@ -63,7 +63,7 @@
    url: string

    Returns TimeoutError

    +
  • Defined in src/types.ts:962

    • Properties

    diff --git a/classes/TokenExpired.html b/classes/TokenExpired.html index e5a14ab..94b2d84 100644 --- a/classes/TokenExpired.html +++ b/classes/TokenExpired.html @@ -26,7 +26,7 @@

    Hierarchy

    • TokenExpired
    +
  • Defined in src/types.ts:1023
    • @@ -66,14 +66,14 @@
    info: Returns TokenExpired
    +
  • Defined in src/types.ts:1024

    • Properties

    Readonly info

    info: TokenExpiredInfo
    +
  • Defined in src/types.ts:1024

    • message

    message: string
    +
  • Defined in src/types.ts:950
    • @@ -67,7 +67,7 @@
    requestId: string
    Returns UnknownError
    +
  • Defined in src/types.ts:951

    • Properties

    @@ -86,7 +86,7 @@

    nameReadonly requestId

    requestId: string
    +
  • Defined in src/types.ts:951

    • Optional stack

    stack?: string
    +
  • Defined in src/types.ts:248
    • @@ -31,12 +31,12 @@

    Enumeration Members

    BEARER

    BEARER: "Bearer"
    +
  • Defined in src/types.ts:249

    • NOOP

    NOOP: "NoOp"
    +
  • Defined in src/types.ts:250
    • diff --git a/enums/Game.html b/enums/Game.html index f947009..99c2207 100644 --- a/enums/Game.html +++ b/enums/Game.html @@ -14,7 +14,7 @@
  • Game

    • Enumeration Game

    +
  • Defined in src/types.ts:556
    • @@ -30,7 +30,7 @@

    Enumeration Members

    DayZ

    DayZ: "1"
    +
  • Defined in src/types.ts:557
    • diff --git a/enums/IPAddressType.html b/enums/IPAddressType.html index f9b94e4..8a69db7 100644 --- a/enums/IPAddressType.html +++ b/enums/IPAddressType.html @@ -14,7 +14,7 @@
  • IPAddressType

    • Enumeration IPAddressType

    +
  • Defined in src/types.ts:392
    • @@ -31,12 +31,12 @@

    Enumeration Members

    v4

    v4: "v4"
    +
  • Defined in src/types.ts:393

    • v6

    v6: "v6"
    +
  • Defined in src/types.ts:393
    • diff --git a/enums/Statistic.html b/enums/Statistic.html index 4e37732..5d2caa1 100644 --- a/enums/Statistic.html +++ b/enums/Statistic.html @@ -14,7 +14,7 @@
  • Statistic

    • Enumeration Statistic

    +
  • Defined in src/types.ts:409
    • @@ -37,17 +37,17 @@

    Enumeration Members

    DEATHS

    DEATHS: "deaths"
    +
  • Defined in src/types.ts:411

    • KILLS

    KILLS: "kills"
    +
  • Defined in src/types.ts:410

    • KILL_DEATH_RATIO

    KILL_DEATH_RATIO: "kdratio"
    +
  • Defined in src/types.ts:416

    • KILL_DEATH_RATION

    KILL_DEATH_RATION: "kdratio"
    @@ -55,27 +55,27 @@

    KILL_DEATH_RATI

    Deprecated

    Use Statistic.KILL_DEATH_RATIO instead

    +
  • Defined in src/types.ts:420

    • LONGEST_KILL

    LONGEST_KILL: "longest_kill"
    +
  • Defined in src/types.ts:414

    • LONGEST_SHOT

    LONGEST_SHOT: "longest_shot"
    +
  • Defined in src/types.ts:415

    • PLAYTIME

    PLAYTIME: "playtime"
    +
  • Defined in src/types.ts:413

    • SUICIDES

    SUICIDES: "suicides"
    +
  • Defined in src/types.ts:412
    • diff --git a/functions/httpClient.html b/functions/httpClient.html index b06025b..04c530f 100644 --- a/functions/httpClient.html +++ b/functions/httpClient.html @@ -34,7 +34,7 @@
    enterprise: boolean
    Optional options: HttpClientOptions

    Returns Got

    +
  • Defined in src/internal/http.ts:182
    • diff --git a/functions/isIpAddress.html b/functions/isIpAddress.html index 8c7e571..2eaa7c1 100644 --- a/functions/isIpAddress.html +++ b/functions/isIpAddress.html @@ -24,7 +24,7 @@

    Parameters

    o: any

    Returns o is IPAddress

    +
  • Defined in src/types.ts:405
    • diff --git a/interfaces/AppGrants.html b/interfaces/AppGrants.html index ee190de..1770a63 100644 --- a/interfaces/AppGrants.html +++ b/interfaces/AppGrants.html @@ -18,7 +18,7 @@

    Hierarchy

    • AppGrants
    +
  • Defined in src/types.ts:1058
    • @@ -35,12 +35,12 @@

    Properties

    banlist

    banlist: { created: Date; resource: BaseResource }[]
    +
  • Defined in src/types.ts:1059

    • server

    server: { created: Date; resource: ServerResource }[]
    +
  • Defined in src/types.ts:1063
    • diff --git a/interfaces/Authorization.html b/interfaces/Authorization.html index edfd84d..acb21fc 100644 --- a/interfaces/Authorization.html +++ b/interfaces/Authorization.html @@ -23,7 +23,7 @@

    Implemented by

  • BearerAuthorization
  • EnterpriseAuthorization
    • +
  • Defined in src/types.ts:253
    • @@ -43,7 +43,7 @@

    asHeader

    Returns Record<string, undefined | string | string[]>

    +
  • Defined in src/types.ts:254

    • throwExpired

      @@ -56,7 +56,7 @@

      Parameters

      url: string

    Returns TokenExpired

    +
  • Defined in src/types.ts:256
    • diff --git a/interfaces/AuthorizationProvider.html b/interfaces/AuthorizationProvider.html index 714f978..bd38e36 100644 --- a/interfaces/AuthorizationProvider.html +++ b/interfaces/AuthorizationProvider.html @@ -18,7 +18,7 @@

    Hierarchy

    • AuthorizationProvider
    +
  • Defined in src/types.ts:222
    • @@ -49,7 +49,7 @@

    Parameters

    client: HttpClient

    Returns Promise<Authorization>

    +
  • Defined in src/types.ts:231

    • reportExpired

    +
  • Defined in src/types.ts:245
    • diff --git a/interfaces/Ban.html b/interfaces/Ban.html index 80ffbcd..0243b3f 100644 --- a/interfaces/Ban.html +++ b/interfaces/Ban.html @@ -18,7 +18,7 @@

    Hierarchy

    • Ban
    +
  • Defined in src/types.ts:697
    • @@ -38,27 +38,27 @@

    Properties

    created

    created: Date
    +
  • Defined in src/types.ts:699

    • expiration

    expiration: Date | "Permanent"
    +
  • Defined in src/types.ts:701

    • id

    id: string
    +
  • Defined in src/types.ts:698

    • reason

    reason: string
    +
  • Defined in src/types.ts:700

    • status

    status: BanStatus
    +
  • Defined in src/types.ts:702
    • diff --git a/interfaces/BaseResource.html b/interfaces/BaseResource.html index 162cb73..351d2ae 100644 --- a/interfaces/BaseResource.html +++ b/interfaces/BaseResource.html @@ -22,7 +22,7 @@

    Hierarchy

    +
  • Defined in src/types.ts:1048
    • @@ -40,17 +40,17 @@

    Properties

    id

    id: string
    +
  • Defined in src/types.ts:1049

    • identifier

    identifier: string
    +
  • Defined in src/types.ts:1050

    • object_id

    object_id: string
    +
  • Defined in src/types.ts:1051
    • diff --git a/interfaces/CFToolsClient.html b/interfaces/CFToolsClient.html index 2794aa3..4abf2fb 100644 --- a/interfaces/CFToolsClient.html +++ b/interfaces/CFToolsClient.html @@ -18,7 +18,7 @@

    Hierarchy

    • CFToolsClient
    +
  • Defined in src/types.ts:3
    • @@ -70,7 +70,7 @@

    Parameters

    request: DeleteBanRequest

    Returns Promise<void>

    +
  • Defined in src/types.ts:164

    • deleteBans

    Returns Promise<void>

    +
  • Defined in src/types.ts:177

    • deletePlayerDetails

    Returns Promise<void>

    +
  • Defined in src/types.ts:23

    • deletePriorityQueue

    Returns Promise<void>

    +
  • Defined in src/types.ts:56

    • deleteWhitelist

    Returns Promise<void>

    +
  • Defined in src/types.ts:80

    • gameLabsAction

    Returns Promise<void>

    +
  • Defined in src/types.ts:107

    • getAppGrants

    +
  • Defined in src/types.ts:9

    • getGameServerDetails

    Returns Promise<GameServerItem>

    +
  • Defined in src/types.ts:86

    • getLeaderboard

    Returns Promise<LeaderboardItem[]>

    +
  • Defined in src/types.ts:31

    • getPlayerDetails

    Returns Promise<Player>

    +
  • Defined in src/types.ts:15

    • getPriorityQueue

    Returns Promise<null | PriorityQueueItem>

    +
  • Defined in src/types.ts:39

    • getServerInfo

    Returns Promise<ServerInfo>

    +
  • Defined in src/types.ts:93

    • getWhitelist

    Returns Promise<null | WhitelistItem>

    +
  • Defined in src/types.ts:64

    • healPlayer

    Returns Promise<void>

    +
  • Defined in src/types.ts:124

    • killPlayer

    Returns Promise<void>

    +
  • Defined in src/types.ts:132

    • listBans

    Returns Promise<Ban[]>

    +
  • Defined in src/types.ts:148

    • listGameSessions

    Returns Promise<GameSession[]>

    +
  • Defined in src/types.ts:99

    • putBan

    Returns Promise<void>

    +
  • Defined in src/types.ts:154

    • putPriorityQueue

    Returns Promise<void>

    +
  • Defined in src/types.ts:48

    • putWhitelist

    Returns Promise<void>

    +
  • Defined in src/types.ts:72

    • resolve

    Returns Promise<CFToolsId>

    +
  • Defined in src/types.ts:183

    • spawnItem

    Returns Promise<void>

    +
  • Defined in src/types.ts:116

    • teleport

    Returns Promise<void>

    +
  • Defined in src/types.ts:140
    • diff --git a/interfaces/Cache.html b/interfaces/Cache.html index 4d996b9..4aac170 100644 --- a/interfaces/Cache.html +++ b/interfaces/Cache.html @@ -18,7 +18,7 @@

    Hierarchy

    • Cache
    +
  • Defined in src/types.ts:203
    • @@ -55,7 +55,7 @@

    Parameters

    cacheKey: string

    Returns undefined | T

    +
  • Defined in src/types.ts:211

    • set

    Returns void

    +
  • Defined in src/types.ts:219
    • diff --git a/interfaces/CacheConfiguration.html b/interfaces/CacheConfiguration.html index 358552f..22fa7c1 100644 --- a/interfaces/CacheConfiguration.html +++ b/interfaces/CacheConfiguration.html @@ -23,7 +23,7 @@

    Hierarchy

    • CacheConfiguration
    +
  • Defined in src/types.ts:309
    • @@ -48,52 +48,52 @@

    Properties

    appGrants

    appGrants: number
    +
  • Defined in src/types.ts:310

    • banlist

    banlist: number
    +
  • Defined in src/types.ts:318

    • gameServerDetails

    gameServerDetails: number
    +
  • Defined in src/types.ts:311

    • gameSessions

    gameSessions: number
    +
  • Defined in src/types.ts:313

    • leaderboard

    leaderboard: number
    +
  • Defined in src/types.ts:314

    • playerDetails

    playerDetails: number
    +
  • Defined in src/types.ts:315

    • priorityQueue

    priorityQueue: number
    +
  • Defined in src/types.ts:316

    • resolve

    resolve: number
    +
  • Defined in src/types.ts:319

    • serverInfo

    serverInfo: number
    +
  • Defined in src/types.ts:312

    • whitelist

    whitelist: number
    +
  • Defined in src/types.ts:317
    • diff --git a/interfaces/Coordinates.html b/interfaces/Coordinates.html index c4792c6..fe2f2e8 100644 --- a/interfaces/Coordinates.html +++ b/interfaces/Coordinates.html @@ -22,7 +22,7 @@

    Hierarchy

    • Coordinates
    +
  • Defined in src/types.ts:837
    • @@ -40,17 +40,17 @@

    Properties

    x

    x: number
    +
  • Defined in src/types.ts:838

    • y

    y: number
    +
  • Defined in src/types.ts:839

    • z

    z: number
    +
  • Defined in src/types.ts:840
    • diff --git a/interfaces/DayZStatistics.html b/interfaces/DayZStatistics.html index 18ffec8..ca5ff6f 100644 --- a/interfaces/DayZStatistics.html +++ b/interfaces/DayZStatistics.html @@ -18,7 +18,7 @@

    Hierarchy

    • DayZStatistics
    +
  • Defined in src/types.ts:510
    • @@ -56,17 +56,17 @@
    other:
    suicides: number
    +
  • Defined in src/types.ts:511

    • hits

    hits: number
    +
  • Defined in src/types.ts:519

    • kdratio

    kdratio: number
    +
  • Defined in src/types.ts:520

    • kills

    kills: { animals: number; infected: number; players: number }
    @@ -80,17 +80,17 @@
    infected:
    players: number
    +
  • Defined in src/types.ts:521

    • longestKill

    longestKill: number
    +
  • Defined in src/types.ts:526

    • longestShot

    longestShot: number
    +
  • Defined in src/types.ts:527

    • weapons

    weapons: { [weaponName: string]: { damage: number; deaths: number; hits: number; kills: number; longestKill: number; longestShot: number; zones: HitZones } }
    @@ -115,12 +115,12 @@
    longestShot:
    zones: HitZones
    +
  • Defined in src/types.ts:529

    • zones

    zones: HitZones
    +
  • Defined in src/types.ts:528
    • diff --git a/interfaces/DeleteBanRequest.html b/interfaces/DeleteBanRequest.html index fe201e7..a446609 100644 --- a/interfaces/DeleteBanRequest.html +++ b/interfaces/DeleteBanRequest.html @@ -18,7 +18,7 @@

    Hierarchy

    • DeleteBanRequest
    +
  • Defined in src/types.ts:712
    • @@ -36,17 +36,17 @@

    Properties

    Optional ban

    ban?: Ban
    +
  • Defined in src/types.ts:714

    • list

    list: Banlist
    +
  • Defined in src/types.ts:715

    • Optional playerId

    playerId?: GenericId
    +
  • Defined in src/types.ts:713
    • diff --git a/interfaces/DeleteBansRequest.html b/interfaces/DeleteBansRequest.html index b77e7e2..4f38553 100644 --- a/interfaces/DeleteBansRequest.html +++ b/interfaces/DeleteBansRequest.html @@ -18,7 +18,7 @@

    Hierarchy

    • DeleteBansRequest
    +
  • Defined in src/types.ts:718
    • @@ -35,12 +35,12 @@

    Properties

    list

    list: Banlist
    +
  • Defined in src/types.ts:720

    • playerId

    playerId: GenericId
    +
  • Defined in src/types.ts:719
    • diff --git a/interfaces/DeletePlayerDetailsRequest.html b/interfaces/DeletePlayerDetailsRequest.html index 4489dfb..c1f5e3b 100644 --- a/interfaces/DeletePlayerDetailsRequest.html +++ b/interfaces/DeletePlayerDetailsRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • DeletePlayerDetailsRequest
    +
  • Defined in src/types.ts:430
    • @@ -40,13 +40,13 @@

    playerIdplayerId: GenericId

    +
  • Defined in src/types.ts:424

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/DeletePriorityQueueRequest.html b/interfaces/DeletePriorityQueueRequest.html index 7b3216a..a94d88c 100644 --- a/interfaces/DeletePriorityQueueRequest.html +++ b/interfaces/DeletePriorityQueueRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • DeletePriorityQueueRequest
    +
  • Defined in src/types.ts:439
    • @@ -40,13 +40,13 @@

    playerIdplayerId: GenericId

    +
  • Defined in src/types.ts:424

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/DeleteWhitelistRequest.html b/interfaces/DeleteWhitelistRequest.html index 452ed9f..a59a0f7 100644 --- a/interfaces/DeleteWhitelistRequest.html +++ b/interfaces/DeleteWhitelistRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • DeleteWhitelistRequest
    +
  • Defined in src/types.ts:442
    • @@ -40,13 +40,13 @@

    playerIdplayerId: GenericId

    +
  • Defined in src/types.ts:424

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/GameEnvironment.html b/interfaces/GameEnvironment.html index de77515..161f451 100644 --- a/interfaces/GameEnvironment.html +++ b/interfaces/GameEnvironment.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameEnvironment
    +
  • Defined in src/types.ts:597
    • @@ -43,12 +43,12 @@
    firstPersonPerspective:
    thirdPersonPerspective: boolean
    +
  • Defined in src/types.ts:598

    • time

    time: string
    +
  • Defined in src/types.ts:602

    • timeAcceleration

    timeAcceleration: { general: number; night: number }
    @@ -60,7 +60,7 @@
    general:
    night: number
    +
  • Defined in src/types.ts:603
    • diff --git a/interfaces/GameHost.html b/interfaces/GameHost.html index c7f1d51..dff0149 100644 --- a/interfaces/GameHost.html +++ b/interfaces/GameHost.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameHost
    +
  • Defined in src/types.ts:566
    • @@ -36,17 +36,17 @@

    Properties

    address

    address: string
    +
  • Defined in src/types.ts:567

    • gamePort

    gamePort: number
    +
  • Defined in src/types.ts:568

    • queryPort

    queryPort: number
    +
  • Defined in src/types.ts:569
    • diff --git a/interfaces/GameHostGeolocation.html b/interfaces/GameHostGeolocation.html index 07c650f..5a8c5b8 100644 --- a/interfaces/GameHostGeolocation.html +++ b/interfaces/GameHostGeolocation.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameHostGeolocation
    +
  • Defined in src/types.ts:572
    • @@ -38,7 +38,7 @@

    Properties

    available

    available: boolean
    +
  • Defined in src/types.ts:573

    • city

    city: { name: null | string; region: null | string }
    @@ -50,12 +50,12 @@
    name:
    region: null | string
    +
  • Defined in src/types.ts:574

    • continent

    continent: string
    +
  • Defined in src/types.ts:578

    • country

    country: { code: string; name: string }
    @@ -67,12 +67,12 @@
    code:
    name: string
    +
  • Defined in src/types.ts:579

    • timezone

    timezone: string
    +
  • Defined in src/types.ts:583
    • diff --git a/interfaces/GameLabsActionBooleanParameter.html b/interfaces/GameLabsActionBooleanParameter.html index 29f6973..30b2ac1 100644 --- a/interfaces/GameLabsActionBooleanParameter.html +++ b/interfaces/GameLabsActionBooleanParameter.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameLabsActionBooleanParameter
    +
  • Defined in src/types.ts:817
    • @@ -35,12 +35,12 @@

    Properties

    dataType

    dataType: "boolean"
    +
  • Defined in src/types.ts:818

    • valueBoolean

    valueBoolean: boolean
    +
  • Defined in src/types.ts:819
    • diff --git a/interfaces/GameLabsActionCfItemListParameter.html b/interfaces/GameLabsActionCfItemListParameter.html index dcb5aea..cfd4a14 100644 --- a/interfaces/GameLabsActionCfItemListParameter.html +++ b/interfaces/GameLabsActionCfItemListParameter.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameLabsActionCfItemListParameter
    +
  • Defined in src/types.ts:829
    • @@ -34,7 +34,7 @@

    Properties

    dataType

    dataType: "cf_itemlist"
    +
  • Defined in src/types.ts:830
    • diff --git a/interfaces/GameLabsActionFloatParameter.html b/interfaces/GameLabsActionFloatParameter.html index 5f12ba1..0cea733 100644 --- a/interfaces/GameLabsActionFloatParameter.html +++ b/interfaces/GameLabsActionFloatParameter.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameLabsActionFloatParameter
    +
  • Defined in src/types.ts:807
    • @@ -35,12 +35,12 @@

    Properties

    dataType

    dataType: "float"
    +
  • Defined in src/types.ts:808

    • valueFloat

    valueFloat: number
    +
  • Defined in src/types.ts:809
    • diff --git a/interfaces/GameLabsActionIntParameter.html b/interfaces/GameLabsActionIntParameter.html index 0199220..aa5b25d 100644 --- a/interfaces/GameLabsActionIntParameter.html +++ b/interfaces/GameLabsActionIntParameter.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameLabsActionIntParameter
    +
  • Defined in src/types.ts:802
    • @@ -35,12 +35,12 @@

    Properties

    dataType

    dataType: "int"
    +
  • Defined in src/types.ts:803

    • valueInt

    valueInt: number
    +
  • Defined in src/types.ts:804
    • diff --git a/interfaces/GameLabsActionRequest.html b/interfaces/GameLabsActionRequest.html index 8a78bcb..8eabe94 100644 --- a/interfaces/GameLabsActionRequest.html +++ b/interfaces/GameLabsActionRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • GameLabsActionRequest
    +
  • Defined in src/types.ts:787
    • @@ -42,12 +42,12 @@

    Properties

    actionCode

    actionCode: string
    +
  • Defined in src/types.ts:788

    • actionContext

    actionContext: "object" | "world" | "player" | "vehicle"
    +
  • Defined in src/types.ts:789

    • parameters

    parameters: { [name: string]: GameLabsActionParameter }
    @@ -57,18 +57,18 @@

    Type declaration

  • [name: string]: GameLabsActionParameter
    • +
  • Defined in src/types.ts:791

    • referenceKey

    referenceKey: string
    +
  • Defined in src/types.ts:790

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/GameLabsActionStringParameter.html b/interfaces/GameLabsActionStringParameter.html index 8bcfbd7..f8e0399 100644 --- a/interfaces/GameLabsActionStringParameter.html +++ b/interfaces/GameLabsActionStringParameter.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameLabsActionStringParameter
    +
  • Defined in src/types.ts:812
    • @@ -35,12 +35,12 @@

    Properties

    dataType

    dataType: "string"
    +
  • Defined in src/types.ts:813

    • valueString

    valueString: string
    +
  • Defined in src/types.ts:814
    • diff --git a/interfaces/GameLabsActionVectorParameter.html b/interfaces/GameLabsActionVectorParameter.html index efd4d2c..8bf4576 100644 --- a/interfaces/GameLabsActionVectorParameter.html +++ b/interfaces/GameLabsActionVectorParameter.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameLabsActionVectorParameter
    +
  • Defined in src/types.ts:822
    • @@ -37,22 +37,22 @@

    Properties

    dataType

    dataType: "vector"
    +
  • Defined in src/types.ts:823

    • valueVectorX

    valueVectorX: number
    +
  • Defined in src/types.ts:824

    • valueVectorY

    valueVectorY: number
    +
  • Defined in src/types.ts:825

    • valueVectorZ

    valueVectorZ: number
    +
  • Defined in src/types.ts:826
    • diff --git a/interfaces/GameSecurity.html b/interfaces/GameSecurity.html index 05bb5c8..383fcbf 100644 --- a/interfaces/GameSecurity.html +++ b/interfaces/GameSecurity.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameSecurity
    +
  • Defined in src/types.ts:586
    • @@ -36,17 +36,17 @@

    Properties

    battleye

    battleye: boolean
    +
  • Defined in src/types.ts:587

    • password

    password: boolean
    +
  • Defined in src/types.ts:589

    • vac

    vac: boolean
    +
  • Defined in src/types.ts:588
    • diff --git a/interfaces/GameServerItem.html b/interfaces/GameServerItem.html index d5afea1..eff4b75 100644 --- a/interfaces/GameServerItem.html +++ b/interfaces/GameServerItem.html @@ -18,7 +18,7 @@

    Hierarchy

    • GameServerItem
    +
  • Defined in src/types.ts:609
    • @@ -66,57 +66,57 @@
    official:
    whitelist: boolean
    +
  • Defined in src/types.ts:628

    • environment

    environment: GameEnvironment
    +
  • Defined in src/types.ts:627

    • geolocation

    geolocation: GameHostGeolocation
    +
  • Defined in src/types.ts:626

    • host

    host: GameHost
    +
  • Defined in src/types.ts:625

    • map

    map: string
    +
  • Defined in src/types.ts:614

    • mods

    mods: SteamWorkshopMod[]
    +
  • Defined in src/types.ts:624

    • name

    name: string
    +
  • Defined in src/types.ts:610

    • online

    online: boolean
    +
  • Defined in src/types.ts:623

    • rank

    rank: number
    +
  • Defined in src/types.ts:611

    • rating

    rating: number
    +
  • Defined in src/types.ts:612

    • security

    security: GameSecurity
    +
  • Defined in src/types.ts:622

    • status

    status: { players: { online: number; queue: number; slots: number } }
    @@ -133,12 +133,12 @@
    queue:
    slots: number
    +
  • Defined in src/types.ts:615

    • version

    version: string
    +
  • Defined in src/types.ts:613
    • diff --git a/interfaces/GameSession.html b/interfaces/GameSession.html index 6e705a5..9373084 100644 --- a/interfaces/GameSession.html +++ b/interfaces/GameSession.html @@ -23,7 +23,7 @@

    Hierarchy

    • GameSession
    +
  • Defined in src/types.ts:665
    • @@ -58,17 +58,17 @@
    Optional gameBanned
    Optional vacBanned?: boolean
    +
  • Defined in src/types.ts:670

    • cftoolsId

    cftoolsId: CFToolsId
    +
  • Defined in src/types.ts:667

    • id

    id: string
    +
  • Defined in src/types.ts:666

    • live

    live: { loadTime?: number; loaded: boolean; ping?: { actual: number; trend: number }; position: { join?: Coordinates; latest?: Coordinates; leave?: Coordinates } }
    @@ -96,12 +96,12 @@
    Optional latest
    Optional leave?: Coordinates
    +
  • Defined in src/types.ts:677

    • playerName

    playerName: string
    +
  • Defined in src/types.ts:668

    • Optional profile

    profile?: { avatar?: URL; name: string; private: boolean }
    @@ -115,12 +115,12 @@
    name:
    private: boolean
    +
  • Defined in src/types.ts:690

    • steamId

    steamId: SteamId64
    +
  • Defined in src/types.ts:669
    • diff --git a/interfaces/GenericId.html b/interfaces/GenericId.html index f9d7ee6..ac209b9 100644 --- a/interfaces/GenericId.html +++ b/interfaces/GenericId.html @@ -26,7 +26,7 @@

    Implemented by

  • IPAddress
  • SteamId64
    • +
  • Defined in src/types.ts:348
    • @@ -42,7 +42,7 @@

    Properties

    Readonly id

    id: string
    +
  • Defined in src/types.ts:349
    • diff --git a/interfaces/GetGameServerDetailsRequest.html b/interfaces/GetGameServerDetailsRequest.html index 75d1888..9fbbd44 100644 --- a/interfaces/GetGameServerDetailsRequest.html +++ b/interfaces/GetGameServerDetailsRequest.html @@ -18,7 +18,7 @@

    Hierarchy

    • GetGameServerDetailsRequest
    +
  • Defined in src/types.ts:560
    • @@ -36,17 +36,17 @@

    Properties

    game

    game: DayZ
    +
  • Defined in src/types.ts:561

    • ip

    ip: string
    +
  • Defined in src/types.ts:562

    • port

    port: number
    +
  • Defined in src/types.ts:563
    • diff --git a/interfaces/GetLeaderboardRequest.html b/interfaces/GetLeaderboardRequest.html index 3734c72..5952882 100644 --- a/interfaces/GetLeaderboardRequest.html +++ b/interfaces/GetLeaderboardRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • GetLeaderboardRequest
    +
  • Defined in src/types.ts:445
    • @@ -41,23 +41,23 @@

    Properties

    Optional limit

    limit?: number
    +
  • Defined in src/types.ts:448

    • order

    order: "ASC" | "DESC"
    +
  • Defined in src/types.ts:446

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849

    • statistic

    statistic: Statistic
    +
  • Defined in src/types.ts:447
    • diff --git a/interfaces/GetPlayerDetailsRequest.html b/interfaces/GetPlayerDetailsRequest.html index d4c6866..1826855 100644 --- a/interfaces/GetPlayerDetailsRequest.html +++ b/interfaces/GetPlayerDetailsRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • GetPlayerDetailsRequest
    +
  • Defined in src/types.ts:427
    • @@ -40,13 +40,13 @@

    playerIdplayerId: GenericId

    +
  • Defined in src/types.ts:424

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/GetPriorityQueueRequest.html b/interfaces/GetPriorityQueueRequest.html index e6b9deb..fc90933 100644 --- a/interfaces/GetPriorityQueueRequest.html +++ b/interfaces/GetPriorityQueueRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • GetPriorityQueueRequest
    +
  • Defined in src/types.ts:433
    • @@ -40,13 +40,13 @@

    playerIdplayerId: GenericId

    +
  • Defined in src/types.ts:424

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/GetServerInfoRequest.html b/interfaces/GetServerInfoRequest.html index 44a614c..a92c18a 100644 --- a/interfaces/GetServerInfoRequest.html +++ b/interfaces/GetServerInfoRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • GetServerInfoRequest
    +
  • Defined in src/types.ts:730
    • @@ -39,7 +39,7 @@

    OptionalserverApiId?: ServerApiId

    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/GetWhitelistRequest.html b/interfaces/GetWhitelistRequest.html index 519031c..406594c 100644 --- a/interfaces/GetWhitelistRequest.html +++ b/interfaces/GetWhitelistRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • GetWhitelistRequest
    +
  • Defined in src/types.ts:436
    • @@ -40,13 +40,13 @@

    playerIdplayerId: GenericId

    +
  • Defined in src/types.ts:424

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/HealPlayerRequest.html b/interfaces/HealPlayerRequest.html index 79a82a9..87ee4ff 100644 --- a/interfaces/HealPlayerRequest.html +++ b/interfaces/HealPlayerRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • HealPlayerRequest
    +
  • Defined in src/types.ts:762
    • @@ -40,12 +40,12 @@

    OptionalserverApiId?: ServerApiId

    +
  • Defined in src/types.ts:849

    • session

    session: GameSession
    +
  • Defined in src/types.ts:763
    • diff --git a/interfaces/HitZones.html b/interfaces/HitZones.html index 8fb00af..5ca0e8d 100644 --- a/interfaces/HitZones.html +++ b/interfaces/HitZones.html @@ -18,7 +18,7 @@

    Hierarchy

    • HitZones
    +
  • Defined in src/types.ts:542
    • @@ -44,57 +44,57 @@

    Properties

    brain

    brain: number
    +
  • Defined in src/types.ts:543

    • head

    head: number
    +
  • Defined in src/types.ts:544

    • leftArm

    leftArm: number
    +
  • Defined in src/types.ts:545

    • leftFoot

    leftFoot: number
    +
  • Defined in src/types.ts:546

    • leftHand

    leftHand: number
    +
  • Defined in src/types.ts:548

    • leftLeg

    leftLeg: number
    +
  • Defined in src/types.ts:547

    • rightArm

    rightArm: number
    +
  • Defined in src/types.ts:549

    • rightFoot

    rightFoot: number
    +
  • Defined in src/types.ts:550

    • rightHand

    rightHand: number
    +
  • Defined in src/types.ts:551

    • rightLeg

    rightLeg: number
    +
  • Defined in src/types.ts:552

    • torso

    torso: number
    +
  • Defined in src/types.ts:553
    • diff --git a/interfaces/HttpClientOptions.html b/interfaces/HttpClientOptions.html index f2120de..1520fcd 100644 --- a/interfaces/HttpClientOptions.html +++ b/interfaces/HttpClientOptions.html @@ -18,7 +18,7 @@

    Hierarchy

    • HttpClientOptions
    +
  • Defined in src/internal/http.ts:153
    • @@ -36,17 +36,17 @@

    Properties

    Optional enableDebugLogging

    enableDebugLogging?: boolean
    +
  • Defined in src/internal/http.ts:154

    • Optional logBody

    logBody?: boolean
    +
  • Defined in src/internal/http.ts:155

    • Optional userAgent

    userAgent?: string
    +
  • Defined in src/internal/http.ts:157
    • diff --git a/interfaces/KillPlayerRequest.html b/interfaces/KillPlayerRequest.html index 14571f2..e1e5969 100644 --- a/interfaces/KillPlayerRequest.html +++ b/interfaces/KillPlayerRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • KillPlayerRequest
    +
  • Defined in src/types.ts:766
    • @@ -40,12 +40,12 @@

    OptionalserverApiId?: ServerApiId

    +
  • Defined in src/types.ts:849

    • session

    session: GameSession
    +
  • Defined in src/types.ts:767
    • diff --git a/interfaces/LeaderboardItem.html b/interfaces/LeaderboardItem.html index 9896236..739d4ac 100644 --- a/interfaces/LeaderboardItem.html +++ b/interfaces/LeaderboardItem.html @@ -18,7 +18,7 @@

    Hierarchy

    • LeaderboardItem
    +
  • Defined in src/types.ts:451
    • @@ -45,62 +45,62 @@

    Properties

    deaths

    deaths: number
    +
  • Defined in src/types.ts:462

    • Optional environmentDeaths

    environmentDeaths?: number
    +
  • Defined in src/types.ts:463

    • hits

    hits: number
    +
  • Defined in src/types.ts:458

    • id

    id: CFToolsId
    +
  • Defined in src/types.ts:452

    • killDeathRatio

    killDeathRatio: number
    +
  • Defined in src/types.ts:459

    • kills

    kills: number
    +
  • Defined in src/types.ts:457

    • longestKill

    longestKill: number
    +
  • Defined in src/types.ts:460

    • longestShot

    longestShot: number
    +
  • Defined in src/types.ts:461

    • name

    name: string
    +
  • Defined in src/types.ts:453

    • playtime

    playtime: number
    +
  • Defined in src/types.ts:454

    • rank

    rank: number
    +
  • Defined in src/types.ts:455

    • suicides

    suicides: number
    +
  • Defined in src/types.ts:456
    • diff --git a/interfaces/ListBansRequest.html b/interfaces/ListBansRequest.html index c8ba95a..0a2e35f 100644 --- a/interfaces/ListBansRequest.html +++ b/interfaces/ListBansRequest.html @@ -18,7 +18,7 @@

    Hierarchy

    • ListBansRequest
    +
  • Defined in src/types.ts:707
    • @@ -35,12 +35,12 @@

    Properties

    list

    list: Banlist
    +
  • Defined in src/types.ts:709

    • playerId

    playerId: GenericId
    +
  • Defined in src/types.ts:708
    • diff --git a/interfaces/ListGameSessionsRequest.html b/interfaces/ListGameSessionsRequest.html index 56e21fb..95e795c 100644 --- a/interfaces/ListGameSessionsRequest.html +++ b/interfaces/ListGameSessionsRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • ListGameSessionsRequest
    +
  • Defined in src/types.ts:733
    • @@ -39,7 +39,7 @@

    OptionalserverApiId?: ServerApiId

    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/OverrideServerApiId.html b/interfaces/OverrideServerApiId.html index abb97be..fed0145 100644 --- a/interfaces/OverrideServerApiId.html +++ b/interfaces/OverrideServerApiId.html @@ -31,7 +31,7 @@

    Hierarchy

  • GameLabsActionRequest
  • TeleportPlayerRequest
    • +
  • Defined in src/types.ts:848
    • @@ -47,7 +47,7 @@

    Properties

    Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/Player.html b/interfaces/Player.html index 5f9adc4..312534b 100644 --- a/interfaces/Player.html +++ b/interfaces/Player.html @@ -18,7 +18,7 @@

    Hierarchy

    • Player
    +
  • Defined in src/types.ts:492
    • @@ -49,24 +49,24 @@
    cftools:
    steam: SteamId64
    +
  • Defined in src/types.ts:497

    • names

    names: string[]
    +
  • Defined in src/types.ts:493

    • playtime

    playtime: number

    Playtime in seconds

    +
  • Defined in src/types.ts:506

    • sessions

    sessions: number
    +
  • Defined in src/types.ts:507

    • statistics

    statistics: { dayz: DayZStatistics }
    @@ -76,7 +76,7 @@

    Type declaration

  • dayz: DayZStatistics
    • +
  • Defined in src/types.ts:494
    • diff --git a/interfaces/PriorityQueueItem.html b/interfaces/PriorityQueueItem.html index db379d5..3e4e6f9 100644 --- a/interfaces/PriorityQueueItem.html +++ b/interfaces/PriorityQueueItem.html @@ -18,7 +18,7 @@

    Hierarchy

    • PriorityQueueItem
    +
  • Defined in src/types.ts:466
    • @@ -37,22 +37,22 @@

    Properties

    comment

    comment: string
    +
  • Defined in src/types.ts:469

    • created

    created: Date
    +
  • Defined in src/types.ts:467

    • createdBy

    createdBy: CFToolsId
    +
  • Defined in src/types.ts:468

    • expiration

    expiration: Date | "Permanent"
    +
  • Defined in src/types.ts:470
    • diff --git a/interfaces/PutBanRequest.html b/interfaces/PutBanRequest.html index fc17e6d..7755028 100644 --- a/interfaces/PutBanRequest.html +++ b/interfaces/PutBanRequest.html @@ -18,7 +18,7 @@

    Hierarchy

    • PutBanRequest
    +
  • Defined in src/types.ts:723
    • @@ -37,22 +37,22 @@

    Properties

    Optional expiration

    expiration?: Date | "Permanent"
    +
  • Defined in src/types.ts:726

    • list

    list: Banlist
    +
  • Defined in src/types.ts:725

    • playerId

    playerId: GenericId
    +
  • Defined in src/types.ts:724

    • reason

    reason: string
    +
  • Defined in src/types.ts:727
    • diff --git a/interfaces/PutPriorityQueueItemRequest.html b/interfaces/PutPriorityQueueItemRequest.html index 15c0f87..6b8ff01 100644 --- a/interfaces/PutPriorityQueueItemRequest.html +++ b/interfaces/PutPriorityQueueItemRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • PutPriorityQueueItemRequest
    +
  • Defined in src/types.ts:480
    • @@ -41,23 +41,23 @@

    Properties

    comment

    comment: string
    +
  • Defined in src/types.ts:482

    • Optional expires

    expires?: Date | "Permanent"
    +
  • Defined in src/types.ts:481

    • id

    id: CFToolsId
    +
  • Defined in src/types.ts:483

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/PutWhitelistItemRequest.html b/interfaces/PutWhitelistItemRequest.html index 0334d49..a2e15f1 100644 --- a/interfaces/PutWhitelistItemRequest.html +++ b/interfaces/PutWhitelistItemRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • PutWhitelistItemRequest
    +
  • Defined in src/types.ts:486
    • @@ -41,23 +41,23 @@

    Properties

    comment

    comment: string
    +
  • Defined in src/types.ts:488

    • Optional expires

    expires?: Date | "Permanent"
    +
  • Defined in src/types.ts:487

    • id

    id: CFToolsId
    +
  • Defined in src/types.ts:489

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849
    • diff --git a/interfaces/ResolveRequestOptions.html b/interfaces/ResolveRequestOptions.html index 4f9164c..c1894df 100644 --- a/interfaces/ResolveRequestOptions.html +++ b/interfaces/ResolveRequestOptions.html @@ -21,7 +21,7 @@

    Hierarchy

    • ResolveRequestOptions
    +
  • Defined in src/types.ts:189
    • @@ -46,7 +46,7 @@

    Throws

    AccountCreationFailed if the account creation failed.

    Throws

    RequestForbidden if the request is forbidden (no Enterprise account, e.g.).

    +
  • Defined in src/types.ts:200
    • diff --git a/interfaces/ServerInfo.html b/interfaces/ServerInfo.html index dc39c8b..bab3191 100644 --- a/interfaces/ServerInfo.html +++ b/interfaces/ServerInfo.html @@ -18,7 +18,7 @@

    Hierarchy

    • ServerInfo
    +
  • Defined in src/types.ts:650
    • @@ -44,22 +44,22 @@
    peerVersion:
    usedProtocol: "UDP_RCON_BATTLEYE_DZ"
    +
  • Defined in src/types.ts:653

    • game

    game: DayZ
    +
  • Defined in src/types.ts:657

    • nickname

    nickname: string
    +
  • Defined in src/types.ts:651

    • owner

    owner: CFToolsId
    +
  • Defined in src/types.ts:652
    • diff --git a/interfaces/ServerResource.html b/interfaces/ServerResource.html index 3cd7bee..fa93c5a 100644 --- a/interfaces/ServerResource.html +++ b/interfaces/ServerResource.html @@ -22,7 +22,7 @@

    Hierarchy

    • ServerResource
    +
  • Defined in src/types.ts:1054
    • @@ -41,25 +41,25 @@

    Properties

    gameserver_id

    gameserver_id: string
    +
  • Defined in src/types.ts:1055

    • id

    id: string
    +
  • Defined in src/types.ts:1049

    • identifier

    identifier: string
    +
  • Defined in src/types.ts:1050

    • object_id

    object_id: string
    +
  • Defined in src/types.ts:1051
    • diff --git a/interfaces/SpawnItemRequest.html b/interfaces/SpawnItemRequest.html index bf9166b..a739660 100644 --- a/interfaces/SpawnItemRequest.html +++ b/interfaces/SpawnItemRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • SpawnItemRequest
    +
  • Defined in src/types.ts:736
    • @@ -46,14 +46,14 @@

    OptionalIf omitted, the default (false) will be used.

    +
  • Defined in src/types.ts:753

    • itemClass

    itemClass: string

    "Class name of item to be spawned

    +
  • Defined in src/types.ts:741

    • Optional quantity

    quantity?: number
    @@ -61,18 +61,18 @@

    OptionalIf omitted, the default value (1) will be used.

    +
  • Defined in src/types.ts:747

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849

    • session

    session: GameSession
    +
  • Defined in src/types.ts:737

    • Optional stacked

    stacked?: boolean
    @@ -80,7 +80,7 @@

    OptionalIf omitted, the default (false) will be used.

    +
  • Defined in src/types.ts:759
    • diff --git a/interfaces/SteamWorkshopMod.html b/interfaces/SteamWorkshopMod.html index 23ea1b4..b5bf41c 100644 --- a/interfaces/SteamWorkshopMod.html +++ b/interfaces/SteamWorkshopMod.html @@ -18,7 +18,7 @@

    Hierarchy

    • SteamWorkshopMod
    +
  • Defined in src/types.ts:592
    • @@ -35,12 +35,12 @@

    Properties

    fileId

    fileId: number
    +
  • Defined in src/types.ts:593

    • name

    name: string
    +
  • Defined in src/types.ts:594
    • diff --git a/interfaces/TeleportPlayerRequest.html b/interfaces/TeleportPlayerRequest.html index 02bc61f..d43b264 100644 --- a/interfaces/TeleportPlayerRequest.html +++ b/interfaces/TeleportPlayerRequest.html @@ -22,7 +22,7 @@

    Hierarchy

    • TeleportPlayerRequest
    +
  • Defined in src/types.ts:843
    • @@ -40,18 +40,18 @@

    Properties

    coordinates

    coordinates: Coordinates
    +
  • Defined in src/types.ts:845

    • Optional serverApiId

    serverApiId?: ServerApiId
    +
  • Defined in src/types.ts:849

    • session

    session: GameSession
    +
  • Defined in src/types.ts:844
    • diff --git a/interfaces/TokenExpiredInfo.html b/interfaces/TokenExpiredInfo.html index 6ca9697..0586952 100644 --- a/interfaces/TokenExpiredInfo.html +++ b/interfaces/TokenExpiredInfo.html @@ -18,7 +18,7 @@

    Hierarchy

    • TokenExpiredInfo
    +
  • Defined in src/types.ts:1002
    • @@ -39,26 +39,26 @@

    Readonly

    The date and time when this token was last created or refreshed.

    +
  • Defined in src/types.ts:1011

    • Readonly expiresAt

    expiresAt: Date

    When this authorization token is expected to expire.

    +
  • Defined in src/types.ts:1015

    • Readonly token

    token: string

    The authorization token that was reported as expired.

    +
  • Defined in src/types.ts:1007

    • Readonly type

    type: AuthorizationType
    +
  • Defined in src/types.ts:1003
    • diff --git a/interfaces/WhitelistItem.html b/interfaces/WhitelistItem.html index 30a35b0..1230ddf 100644 --- a/interfaces/WhitelistItem.html +++ b/interfaces/WhitelistItem.html @@ -18,7 +18,7 @@

    Hierarchy

    • WhitelistItem
    +
  • Defined in src/types.ts:473
    • @@ -37,22 +37,22 @@

    Properties

    comment

    comment: string
    +
  • Defined in src/types.ts:476

    • created

    created: Date
    +
  • Defined in src/types.ts:474

    • createdBy

    createdBy: CFToolsId
    +
  • Defined in src/types.ts:475

    • expiration

    expiration: Date | "Permanent"
    +
  • Defined in src/types.ts:477
    • diff --git a/types/BanStatus.html b/types/BanStatus.html index 661346d..46fc060 100644 --- a/types/BanStatus.html +++ b/types/BanStatus.html @@ -15,7 +15,7 @@

    Type alias BanStatus

    BanStatus: "Ban.ACTIVE" | "Ban.INACTIVE"
    +
  • Defined in src/types.ts:705
    • diff --git a/types/DayZGameLabsActions.html b/types/DayZGameLabsActions.html index 4866f19..e29fe1b 100644 --- a/types/DayZGameLabsActions.html +++ b/types/DayZGameLabsActions.html @@ -15,7 +15,7 @@

    Type alias DayZGameLabsActions

    DayZGameLabsActions: "CFCloud_SpawnPlayerItem" | "CFCloud_TeleportPlayer" | "CFCloud_HealPlayer" | "CFCloud_KillPlayer" | "CFCloud_ExplodePlayer" | "CFCloud_StripPlayer" | "CFCloud_DeleteVehicle" | "CFCloud_WorldTime" | "CFCloud_WorldWeather" | "CFCloud_WorldWeatherSunny" | "CFCloud_WorldWipeAI" | "CFCloud_WorldWipeVehicles" | "CFCloud_SpawnItemWorld" | "CFCloud_ObjectDelete" | "CFCloud_TerritoryFlagClear"
    +
  • Defined in src/types.ts:770
    • diff --git a/types/GameLabsActionParameter.html b/types/GameLabsActionParameter.html index 8199770..2731d4b 100644 --- a/types/GameLabsActionParameter.html +++ b/types/GameLabsActionParameter.html @@ -15,7 +15,7 @@

    Type alias GameLabsActionParameter

    GameLabsActionParameter: GameLabsActionIntParameter | GameLabsActionFloatParameter | GameLabsActionStringParameter | GameLabsActionBooleanParameter | GameLabsActionVectorParameter | GameLabsActionCfItemListParameter
    +
  • Defined in src/types.ts:794