bancho.js 0.11.2 → 0.11.4

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Version 0.11
 
+### Version 0.11.4
+
+- Add argument types to utility functions
+
+### Version 0.11.3
+
+- Add missing exports from typings
+
 ### Version 0.11.2
 
 - BanchoLobby: Fix mods listener never unset in `updateSettings`  

package/README.md

@@ -3,7 +3,7 @@
 [![NPM](https://nodei.co/npm/bancho.js.png?compact=true)](https://nodei.co/npm/bancho.js/)  
 [![pipeline status](https://git.cartooncraft.fr/ThePooN/bancho.js/badges/master/pipeline.svg)](https://git.cartooncraft.fr/ThePooN/bancho.js/commits/master)
 
-## Current release: 0.11.2
+## Current release: 0.11.4
 
 # Introduction
 

package/index.d.ts

@@ -132,7 +132,7 @@ declare module "bancho.js" {
 		
 	}
 
-	class BanchoUser extends EventEmitter {
+	export class BanchoUser extends EventEmitter {
 		/**
 		 * Creates an instance of BanchoUser.
 		 * @param banchojs Bancho.js client this user was instancied by
@@ -216,7 +216,7 @@ declare module "bancho.js" {
 	/**
 	 * Class describing what is returned after a WHOIS query on an online user
 	 */
-	class BanchoWhoisReturn {
+	export class BanchoWhoisReturn {
 		/**
 		 * Username of the queried user
 		 */
@@ -234,7 +234,7 @@ declare module "bancho.js" {
 	/**
 	 * Contains properties returned by the BanchoBot !stats command that can't be set in BanchoUser.
 	 */
-	class BanchoBotStatsReturn {
+	export class BanchoBotStatsReturn {
 		user: BanchoUser
 		/**
 		 * Truncated value of levels (eg. 102)
@@ -276,7 +276,7 @@ declare module "bancho.js" {
 	/**
 	 * Represents a discussion channel (not including PMs)
 	 */
-	class BanchoChannel extends EventEmitter {
+	export class BanchoChannel extends EventEmitter {
 		/**
 		 * @param name Channel name as it is referred by on IRC (including #)
 		 */
@@ -318,7 +318,7 @@ declare module "bancho.js" {
 		on(event: "PART", listener: (member: BanchoChannelMember) => void): this
 	}
 
-	class BanchoMultiplayerChannel extends BanchoChannel {
+	export class BanchoMultiplayerChannel extends BanchoChannel {
 		/**
 		 * @param name Channel name as it is referred by on IRC (including #)
 		 */
@@ -331,7 +331,7 @@ declare module "bancho.js" {
 	 * 
  	 * Highly recommended to await updateSettings before manipulating (else some properties will be null).
 	 */
-	class BanchoLobby extends EventEmitter {
+	export class BanchoLobby extends EventEmitter {
 		channel: BanchoMultiplayerChannel
 		/**
 		 * Multiplayer lobby ID (used in multiplayer history links)
@@ -601,7 +601,7 @@ declare module "bancho.js" {
 		on(event: "userNotFoundUsername", listener: (username: string) => void): this
 	}
 
-	class BanchoLobbyPlayer {
+	export class BanchoLobbyPlayer {
 		lobby: BanchoLobby
 		user: BanchoUser
 		/**
@@ -617,13 +617,13 @@ declare module "bancho.js" {
 		score: BanchoLobbyPlayerScore
 	}
 
-	class BanchoLobbyPlayerScore {
+	export class BanchoLobbyPlayerScore {
 		score: number
 		pass: boolean
 		player: BanchoLobbyPlayer
 	}
 
-	class BanchoMod {
+	export class BanchoMod {
 		enumValue: number
 		shortMod: string
 		longMod: string
@@ -633,7 +633,7 @@ declare module "bancho.js" {
 	 * A Bancho channel user mode, or "IRC modes".
 	 * Used by Bancho to mark someone in a channel as an IRC user or a moderator.
 	 */
-	class BanchoChannelMemberMode {
+	export class BanchoChannelMemberMode {
 		/**
 		 * @param ircLetter Letter used in the MODE command to represent this mode
 		 * @param name Name to describe the mode
@@ -642,7 +642,7 @@ declare module "bancho.js" {
 	}
 
 	/** A Bancho channel member */
-	class BanchoChannelMember {
+	export class BanchoChannelMember {
 		/**
 		 * @param client 
 		 * @param channel 
@@ -685,7 +685,7 @@ declare module "bancho.js" {
 	/**
 	 * Static class with a property for each mods and methods to manipulate them
 	 */
-	class BanchoModsTypes {
+	type BanchoModsTypes = {
 		None: BanchoMod
 		NoFail: BanchoMod
 		Easy: BanchoMod
@@ -904,23 +904,23 @@ declare module "bancho.js" {
 	}
 
 	/** Compares the provided object and return true if the object is an instance of BanchoMod. */
-	export function isBanchoMod(mod): boolean
+	export function isBanchoMod(mod: BanchoMod): boolean
 	/** Compares the provided object and return true if the object is an instance of BanchoUser. */
-	export function isBanchoUser(user): boolean
+	export function isBanchoUser(user: BanchoUser): boolean
 	/** Compares the provided object and return true if the object is an instance of BanchoChannel. */
-	export function isBanchoChannel(channel): boolean
+	export function isBanchoChannel(channel: BanchoChannel): boolean
 	/** Compares the provided object and return true if the object is an instance of BanchoMultiplayerChannel. */
-	export function isBanchoMultiplayerChannel(channel): boolean
+	export function isBanchoMultiplayerChannel(channel: BanchoMultiplayerChannel): boolean
 	/** Compares the provided object and return true if the object is an instance of BanchoLobby. */
-	export function isBanchoLobby(lobby): boolean
+	export function isBanchoLobby(lobby: BanchoLobby): boolean
 	/** Compares the provided object and return true if the object is an instance of BanchoChannelMember. */
-	export function isBanchoChannelMember(member): boolean
+	export function isBanchoChannelMember(member: BanchoChannelMember): boolean
 	/** Compares the provided object and return true if the object is an instance of BanchoMessage. */
-	export function isBanchoMessage(message): boolean
+	export function isBanchoMessage(message: BanchoMessage): boolean
 	/** Compares the provided object and return true if the object is an instance of ChannelMessage. */
-	export function isChannelMessage(message): boolean
+	export function isChannelMessage(message: ChannelMessage): boolean
 	/** Compares the provided object and return true if the object is an instance of PrivateMessage. */
-	export function isPrivateMessage(message): boolean
+	export function isPrivateMessage(message: PrivateMessage): boolean
 
 	/**
 	 * Contains the different connect states: Disconnected, Connecting, Reconnecting, Connected.

package/index.js

@@ -21,6 +21,17 @@ class Banchojs {
 		this.BanchoLobbyTeams = require("./lib/Multiplayer/Enums/BanchoLobbyTeams");
 		this.BanchoLobbyWinConditions = require("./lib/Multiplayer/Enums/BanchoLobbyWinConditions");
 		this.BanchoMods = require("./lib/Multiplayer/Enums/BanchoMods");
+		this.BanchoUser = require("./lib/BanchoUser");
+		this.BanchoWhoisReturn = require("./lib/IrcCommands/whois/BanchoWhoisReturn");
+		this.BanchoBotStatsReturn = require("./lib/StatsCommand/BanchoBotStatsReturn");
+		this.BanchoChannel = require("./lib/BanchoChannel");
+		this.BanchoMultiplayerChannel = require("./lib/BanchoMultiplayerChannel");
+		this.BanchoLobby = require("./lib/Multiplayer/BanchoLobby");
+		this.BanchoLobbyPlayer = require("./lib/Multiplayer/BanchoLobbyPlayer");
+		this.BanchoLobbyPlayerScore = require("./lib/Multiplayer/BanchoLobbyPlayerScore");
+		this.BanchoMod = require("./lib/Multiplayer/BanchoMod");
+		this.BanchoChannelMemberMode = require("./lib/BanchoChannelMemberMode");
+		this.BanchoChannelMember = require("./lib/BanchoChannelMember");
 	}
 
 	/**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bancho.js",
-  "version": "0.11.2",
+  "version": "0.11.4",
   "description": "Interface with Bancho over IRC, made easy and reliable",
   "main": "index.js",
   "types": "index.d.ts",