Skip to content

Commit

Permalink
🤖 Merge PR #69624 [gamedig] Fix attw errors for 5.0 stable by @andrew…
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewbranch committed May 16, 2024
1 parent cc00beb commit 51c7dbd
Show file tree
Hide file tree
Showing 4 changed files with 99 additions and 93 deletions.
3 changes: 3 additions & 0 deletions types/gamedig/gamedig-tests.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import gamedig = require("gamedig");
import { GameDig } from "gamedig";

GameDig.getInstance();

// direct usage from import
gamedig.GameDig.query(
Expand Down
89 changes: 89 additions & 0 deletions types/gamedig/index.d.cts
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
export class GameDig {
constructor(runnerOpts?: { listenUdpPort?: number });
query(options: QueryOptions): Promise<QueryResult>;
query(options: QueryOptions, callback: (error: Error, state: QueryResult) => void): void;

static query(options: QueryOptions): Promise<QueryResult>;
static query(options: QueryOptions, callback: (error: Error, state: QueryResult) => void): void;
static getInstance(): GameDig;
}

export interface games {
[key: string]: {
name: string;
release_year: number;
options: {
protocol: string;
port?: number;
port_query?: number;
port_query_offset?: number | number[];
};
extra?: {
doc_notes?: string;
old_id?: string;
// alias?: string;
};
};
}

export interface protocols {
[key: string]: object;
}

export interface Player {
name?: string;
raw?: object;
ping?: number;
score?: number;
team?: string;
address?: string;
}

export interface QueryOptions {
type: string;
host: string;
address?: string;
port?: number;
maxRetries?: number;
socketTimeout?: number;
attemptTimeout?: number;
givenPortOnly?: boolean;
ipFamily?: 0 | 4 | 6;
debug?: boolean;
portCache?: boolean;
stripColors?: boolean;
noBreadthOrder?: boolean;
checkOldIDs?: boolean;
// checkAlias?: boolean;
// Valve
requestRules?: boolean;
requestRulesRequired?: boolean;
requestPlayersRequired?: boolean;
// Discord
guildId?: string;
// Nadeo
login?: string;
password?: string;
// Teamspeak 3
teamspeakQueryPort?: number;
// Terraria
token?: string;
}

export interface QueryResult {
name: string;
map: string;
password: boolean;
numplayers: number;
maxplayers: number;
players: Player[];
bots: Player[];
connect: string;
ping: number;
queryPort: number;
version: string;
raw?: object;
}

export const games: games;
export const protocols: protocols;
92 changes: 1 addition & 91 deletions types/gamedig/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,91 +1 @@
export class GameDig {
constructor(runnerOpts?: { listenUdpPort?: number });
query(options: QueryOptions): Promise<QueryResult>;
query(options: QueryOptions, callback: (error: Error, state: QueryResult) => void): void;

static query(options: QueryOptions): Promise<QueryResult>;
static query(options: QueryOptions, callback: (error: Error, state: QueryResult) => void): void;
static getInstance(): GameDig;
}

export interface games {
[key: string]: {
name: string;
release_year: number;
options: {
protocol: string;
port?: number;
port_query?: number;
port_query_offset?: number | number[];
};
extra?: {
doc_notes?: string;
old_id?: string;
// alias?: string;
};
};
}

export interface protocols {
[key: string]: object;
}

export interface Player {
name?: string;
raw?: object;
ping?: number;
score?: number;
team?: string;
address?: string;
}

export interface QueryOptions {
type: string;
host: string;
address?: string;
port?: number;
maxRetries?: number;
socketTimeout?: number;
attemptTimeout?: number;
givenPortOnly?: boolean;
ipFamily?: 0 | 4 | 6;
debug?: boolean;
portCache?: boolean;
stripColors?: boolean;
noBreadthOrder?: boolean;
checkOldIDs?: boolean;
// checkAlias?: boolean;
// Valve
requestRules?: boolean;
requestRulesRequired?: boolean;
requestPlayersRequired?: boolean;
// Discord
guildId?: string;
// Nadeo
login?: string;
password?: string;
// Teamspeak 3
teamspeakQueryPort?: number;
// Terraria
token?: string;
}

export interface QueryResult {
name: string;
map: string;
password: boolean;
numplayers: number;
maxplayers: number;
players: Player[];
bots: Player[];
connect: string;
ping: number;
queryPort: number;
version: string;
raw?: object;
}

export const games: games;
export const protocols: protocols;

export as namespace gamedig;
export * from "./index.cjs";
8 changes: 6 additions & 2 deletions types/gamedig/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,9 @@
"name": "Joshua Schmeder",
"githubUsername": "MaximumWoahverdrive"
}
]
}
],
"exports": {
"import": "./index.d.ts",
"require": "./index.d.cts"
}
}

0 comments on commit 51c7dbd

Please sign in to comment.