Socket
Socket
Sign inDemoInstall

@types/tmi.js

Package Overview
Dependencies
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/tmi.js - npm Package Compare versions

Comparing version 1.8.3 to 1.8.4

277

tmi.js/index.d.ts

@@ -42,3 +42,8 @@ // Type definitions for tmi.js 1.8

subscribersoff(channel: string): Promise<[string]>;
timeout(channel: string, username: string, length?: number, reason?: string): Promise<[string, string, number, string]>;
timeout(
channel: string,
username: string,
length?: number,
reason?: string,
): Promise<[string, string, number, string]>;
unban(channel: string, username: string): Promise<[string, string]>;

@@ -56,5 +61,16 @@ unhost(channel: string): Promise<[string]>;

anongiftpaidupgrade(channel: string, username: string, userstate: AnonSubGiftUpgradeUserstate): void;
anonsubmysterygift(channel: string, numbOfSubs: number, methods: SubMethods, userstate: AnonSubMysteryGiftUserstate): void;
anonsubgift(channel: string, streakMonths: number, recipient: string, methods: SubMethods, userstate: AnonSubGiftUserstate): void;
automod(channel: string, msgID: 'msg_rejected' | 'msg_rejected_mandatory', message: string): void;
anonsubmysterygift(
channel: string,
numbOfSubs: number,
methods: SubMethods,
userstate: AnonSubMysteryGiftUserstate,
): void;
anonsubgift(
channel: string,
streakMonths: number,
recipient: string,
methods: SubMethods,
userstate: AnonSubGiftUserstate,
): void;
automod(channel: string, msgID: "msg_rejected" | "msg_rejected_mandatory", message: string): void;
ban(channel: string, username: string, reason: string, userstate: BanUserstate): void;

@@ -89,11 +105,42 @@ chat(channel: string, userstate: ChatUserstate, message: string, self: boolean): void;

// additional string literals for autocomplete
redeem(channel: string, username: string, rewardType: 'highlighted-message' | 'skip-subs-mode-message' | string, tags: ChatUserstate): void;
resub(channel: string, username: string, months: number, message: string, userstate: SubUserstate, methods: SubMethods): void;
redeem(
channel: string,
username: string,
rewardType: "highlighted-message" | "skip-subs-mode-message" | string,
tags: ChatUserstate,
): void;
resub(
channel: string,
username: string,
months: number,
message: string,
userstate: SubUserstate,
methods: SubMethods,
): void;
roomstate(channel: string, state: RoomState): void;
serverchange(channel: string): void;
slowmode(channel: string, enabled: boolean, length: number): void;
subgift(channel: string, username: string, streakMonths: number, recipient: string, methods: SubMethods, userstate: SubGiftUserstate): void;
submysterygift(channel: string, username: string, numbOfSubs: number, methods: SubMethods, userstate: SubMysteryGiftUserstate): void;
subgift(
channel: string,
username: string,
streakMonths: number,
recipient: string,
methods: SubMethods,
userstate: SubGiftUserstate,
): void;
submysterygift(
channel: string,
username: string,
numbOfSubs: number,
methods: SubMethods,
userstate: SubMysteryGiftUserstate,
): void;
subscribers(channel: string, enabled: boolean): void;
subscription(channel: string, username: string, methods: SubMethods, message: string, userstate: SubUserstate): void;
subscription(
channel: string,
username: string,
methods: SubMethods,
message: string,
userstate: SubUserstate,
): void;
timeout(channel: string, username: string, reason: string, duration: number, userstate: TimeoutUserstate): void;

@@ -136,4 +183,4 @@ unhost(channel: string, viewers: number): void;

founder?: string | undefined;
['bits-leader']?: string | undefined;
['sub-gifter']?: string | undefined;
["bits-leader"]?: string | undefined;
["sub-gifter"]?: string | undefined;
[other: string]: string | undefined;

@@ -161,3 +208,3 @@ }

badges?: Badges | undefined;
'badge-info'?: BadgeInfo | undefined;
"badge-info"?: BadgeInfo | undefined;
color?: string | undefined;

@@ -169,8 +216,8 @@ "display-name"?: string | undefined;

turbo?: boolean | undefined;
'emotes-raw'?: string | undefined;
'badges-raw'?: string | undefined;
'badge-info-raw'?: string | undefined;
"emotes-raw"?: string | undefined;
"badges-raw"?: string | undefined;
"badge-info-raw"?: string | undefined;
"room-id"?: string | undefined;
subscriber?: boolean | undefined;
'user-type'?: "" | "mod" | "global_mod" | "admin" | "staff" | undefined;
"user-type"?: "" | "mod" | "global_mod" | "admin" | "staff" | undefined;
"user-id"?: string | undefined;

@@ -201,3 +248,3 @@ "tmi-sent-ts"?: string | undefined;

export interface ChatUserstate extends CommonUserstate {
'message-type'?: "chat" | "action" | "whisper" | undefined;
"message-type"?: "chat" | "action" | "whisper" | undefined;
username?: string | undefined;

@@ -208,3 +255,3 @@ bits?: string | undefined;

export interface SubUserstate extends CommonSubUserstate {
'message-type'?: "sub" | "resub" | undefined;
"message-type"?: "sub" | "resub" | undefined;
"msg-param-cumulative-months"?: string | boolean | undefined;

@@ -216,11 +263,11 @@ "msg-param-should-share-streak"?: boolean | undefined;

export interface SubMysteryGiftUserstate extends CommonSubUserstate {
'message-type'?: "submysterygift" | undefined;
"message-type"?: "submysterygift" | undefined;
"msg-param-sender-count"?: string | boolean | undefined;
'msg-param-origin-id': string;
"msg-param-origin-id": string;
}
export interface SubGiftUserstate extends CommonGiftSubUserstate {
'message-type'?: "subgift" | undefined;
"message-type"?: "subgift" | undefined;
"msg-param-sender-count"?: string | boolean | undefined;
'msg-param-origin-id': string;
"msg-param-origin-id": string;
}

@@ -233,3 +280,3 @@

export interface AnonSubMysteryGiftUserstate extends CommonSubUserstate {
'message-type'?: "anonsubmysterygift" | undefined;
"message-type"?: "anonsubmysterygift" | undefined;
}

@@ -264,5 +311,5 @@

export interface BanUserstate {
'room-id'?: string | undefined;
'target-user-id'?: string | undefined;
'tmi-sent-ts'?: string | undefined;
"room-id"?: string | undefined;
"target-user-id"?: string | undefined;
"tmi-sent-ts"?: string | undefined;
}

@@ -274,13 +321,14 @@

export type Userstate = ChatUserstate |
SubUserstate |
SubGiftUserstate |
SubGiftUpgradeUserstate |
AnonSubGiftUserstate |
SubMysteryGiftUserstate |
AnonSubGiftUpgradeUserstate |
RaidUserstate |
RitualUserstate |
BanUserstate |
TimeoutUserstate;
export type Userstate =
| ChatUserstate
| SubUserstate
| SubGiftUserstate
| SubGiftUpgradeUserstate
| AnonSubGiftUserstate
| SubMysteryGiftUserstate
| AnonSubGiftUpgradeUserstate
| RaidUserstate
| RitualUserstate
| BanUserstate
| TimeoutUserstate;

@@ -294,78 +342,79 @@ export interface EmoteObj {

export type MsgID = "already_banned" |
"already_emote_only_on" |
"already_emote_only_off" |
"already_subs_on" |
"already_subs_off" |
"bad_ban_admin" |
"bad_ban_anon" |
"bad_ban_broadcaster" |
"bad_ban_global_mod" |
"bad_ban_mod" |
"bad_ban_self" |
"bad_ban_staff" |
"bad_commercial_error" |
"bad_host_hosting" |
"bad_host_rate_exceeded" |
"bad_mod_mod" |
"bad_mod_banned" |
"bad_timeout_admin" |
"bad_timeout_anon" |
"bad_timeout_global_mod" |
"bad_timeout_mod" |
"bad_timeout_self" |
"bad_timeout_staff" |
"bad_unban_no_ban" |
"bad_unmod_mod" |
"ban_success" |
"cmds_available" |
"color_changed" |
"commercial_success" |
"emote_only_on" |
"emote_only_off" |
"hosts_remaining" |
"host_target_went_offline" |
"mod_success" |
"msg_banned" |
"msg_censored_broadcaster" |
"msg_channel_suspended" |
"msg_duplicate" |
"msg_emoteonly" |
"msg_ratelimit" |
"msg_subsonly" |
"msg_timedout" |
"msg_verified_email" |
"no_help" |
"no_permission" |
"not_hosting" |
"timeout_success" |
"unban_success" |
"unmod_success" |
"unrecognized_cmd" |
"usage_ban" |
"usage_clear" |
"usage_color" |
"usage_commercial" |
"usage_disconnect" |
"usage_emote_only_on" |
"usage_emote_only_off" |
"usage_help" |
"usage_host" |
"usage_me" |
"usage_mod" |
"usage_mods" |
"usage_r9k_on" |
"usage_r9k_off" |
"usage_slow_on" |
"usage_slow_off" |
"usage_subs_on" |
"usage_subs_off" |
"usage_timeout" |
"usage_unban" |
"usage_unhost" |
"usage_unmod" |
"whisper_invalid_self" |
"whisper_limit_per_min" |
"whisper_limit_per_sec" |
"whisper_restricted_recipient";
export type MsgID =
| "already_banned"
| "already_emote_only_on"
| "already_emote_only_off"
| "already_subs_on"
| "already_subs_off"
| "bad_ban_admin"
| "bad_ban_anon"
| "bad_ban_broadcaster"
| "bad_ban_global_mod"
| "bad_ban_mod"
| "bad_ban_self"
| "bad_ban_staff"
| "bad_commercial_error"
| "bad_host_hosting"
| "bad_host_rate_exceeded"
| "bad_mod_mod"
| "bad_mod_banned"
| "bad_timeout_admin"
| "bad_timeout_anon"
| "bad_timeout_global_mod"
| "bad_timeout_mod"
| "bad_timeout_self"
| "bad_timeout_staff"
| "bad_unban_no_ban"
| "bad_unmod_mod"
| "ban_success"
| "cmds_available"
| "color_changed"
| "commercial_success"
| "emote_only_on"
| "emote_only_off"
| "hosts_remaining"
| "host_target_went_offline"
| "mod_success"
| "msg_banned"
| "msg_censored_broadcaster"
| "msg_channel_suspended"
| "msg_duplicate"
| "msg_emoteonly"
| "msg_ratelimit"
| "msg_subsonly"
| "msg_timedout"
| "msg_verified_email"
| "no_help"
| "no_permission"
| "not_hosting"
| "timeout_success"
| "unban_success"
| "unmod_success"
| "unrecognized_cmd"
| "usage_ban"
| "usage_clear"
| "usage_color"
| "usage_commercial"
| "usage_disconnect"
| "usage_emote_only_on"
| "usage_emote_only_off"
| "usage_help"
| "usage_host"
| "usage_me"
| "usage_mod"
| "usage_mods"
| "usage_r9k_on"
| "usage_r9k_off"
| "usage_slow_on"
| "usage_slow_off"
| "usage_subs_on"
| "usage_subs_off"
| "usage_timeout"
| "usage_unban"
| "usage_unhost"
| "usage_unmod"
| "whisper_invalid_self"
| "whisper_limit_per_min"
| "whisper_limit_per_sec"
| "whisper_restricted_recipient";

@@ -424,3 +473,3 @@ export type SubMethod = "Prime" | "1000" | "2000" | "3000";

(opts: Options): Client;
new (opts: Options): Client;
new(opts: Options): Client;
}

@@ -427,0 +476,0 @@

6

tmi.js/package.json
{
"name": "@types/tmi.js",
"version": "1.8.3",
"version": "1.8.4",
"description": "TypeScript definitions for tmi.js",

@@ -38,4 +38,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tmi.js",

"dependencies": {},
"typesPublisherContentHash": "306c4957f66837b65b86f72ea06a42401f7dd8b0ea8819ddf5b3ae6515b7c2bf",
"typeScriptVersion": "4.2"
"typesPublisherContentHash": "58045badedfb7a5d99cae559c124d4d995057faaf644acf20aafe75fefc5595e",
"typeScriptVersion": "4.3"
}

2

tmi.js/README.md

@@ -11,3 +11,3 @@ # Installation

### Additional Details
* Last updated: Fri, 10 Feb 2023 18:02:36 GMT
* Last updated: Tue, 12 Sep 2023 12:34:45 GMT
* Dependencies: none

@@ -14,0 +14,0 @@ * Global values: none

106

tmi.js/strict-event-emitter-types/index.d.ts

@@ -18,51 +18,99 @@ /**

declare const assignmentCompatibilityHack: unique symbol;
export type MatchingKeys<TRecord, TMatch, K extends keyof TRecord = keyof TRecord> = K extends (TRecord[K] extends TMatch ? K : never) ? K : never;
export type MatchingKeys<TRecord, TMatch, K extends keyof TRecord = keyof TRecord> = K extends
(TRecord[K] extends TMatch ? K : never) ? K : never;
export type VoidKeys<Record> = MatchingKeys<Record, void>;
export interface TypeRecord<T, U, V> {
' _emitterType'?: T | undefined;
' _eventsType'?: U | undefined;
' _emitType'?: V | undefined;
" _emitterType"?: T | undefined;
" _eventsType"?: U | undefined;
" _emitType"?: V | undefined;
}
export type ReturnTypeOfMethod<T> = T extends (...args: any[]) => any ? ReturnType<T> : never;
export type ReturnTypeOfMethodIfExists<T, S extends string> = S extends keyof T ? ReturnTypeOfMethod<T[S]> : never;
export type InnerEEMethodReturnType<T, TValue, FValue> = T extends (...args: any[]) => any ? ReturnType<T> extends never | undefined ? FValue : TValue : FValue;
export type EEMethodReturnType<T, S extends string, TValue, FValue = void> = S extends keyof T ? InnerEEMethodReturnType<T[S], TValue, FValue> : FValue;
export type InnerEEMethodReturnType<T, TValue, FValue> = T extends (...args: any[]) => any
? ReturnType<T> extends never | undefined ? FValue : TValue
: FValue;
export type EEMethodReturnType<T, S extends string, TValue, FValue = void> = S extends keyof T
? InnerEEMethodReturnType<T[S], TValue, FValue>
: FValue;
type ListenerType<T> = [T] extends [(...args: infer U) => any] ? U : [T] extends [never] ? [] : [T];
export interface OverriddenMethods<TEmitter, TEventRecord, TEmitRecord = TEventRecord> {
on<P extends keyof TEventRecord, T>(this: T, event: P, listener: (...args: ListenerType<TEventRecord[P]>) => void): EEMethodReturnType<TEmitter, 'on', T>;
on<P extends keyof TEventRecord, T>(
this: T,
event: P,
listener: (...args: ListenerType<TEventRecord[P]>) => void,
): EEMethodReturnType<TEmitter, "on", T>;
on(event: typeof assignmentCompatibilityHack, listener: (...args: any[]) => any): void;
addListener<P extends keyof TEventRecord, T>(this: T, event: P, listener: (...args: ListenerType<TEventRecord[P]>) => void): EEMethodReturnType<TEmitter, 'addListener', T>;
addListener<P extends keyof TEventRecord, T>(
this: T,
event: P,
listener: (...args: ListenerType<TEventRecord[P]>) => void,
): EEMethodReturnType<TEmitter, "addListener", T>;
addListener(event: typeof assignmentCompatibilityHack, listener: (...args: any[]) => any): void;
addEventListener<P extends keyof TEventRecord, T>(this: T, event: P, listener: (...args: ListenerType<TEventRecord[P]>) => void): EEMethodReturnType<TEmitter, 'addEventListener', T>;
addEventListener<P extends keyof TEventRecord, T>(
this: T,
event: P,
listener: (...args: ListenerType<TEventRecord[P]>) => void,
): EEMethodReturnType<TEmitter, "addEventListener", T>;
addEventListener(event: typeof assignmentCompatibilityHack, listener: (...args: any[]) => any): void;
removeListener<T>(this: T, event: keyof TEventRecord, listener: (...args: any[]) => any): EEMethodReturnType<TEmitter, 'removeListener', T>;
removeListener<T>(
this: T,
event: keyof TEventRecord,
listener: (...args: any[]) => any,
): EEMethodReturnType<TEmitter, "removeListener", T>;
removeListener(event: typeof assignmentCompatibilityHack, listener: (...args: any[]) => any): void;
removeEventListener<T>(this: T, event: keyof TEventRecord, listener: (...args: any[]) => any): EEMethodReturnType<TEmitter, 'removeEventListener', T>;
removeEventListener<T>(
this: T,
event: keyof TEventRecord,
listener: (...args: any[]) => any,
): EEMethodReturnType<TEmitter, "removeEventListener", T>;
removeEventListener(event: typeof assignmentCompatibilityHack, listener: (...args: any[]) => any): void;
once<P extends keyof TEventRecord, T>(this: T, event: P, listener: (...args: ListenerType<TEventRecord[P]>) => void): EEMethodReturnType<TEmitter, 'once', T>;
once<P extends keyof TEventRecord, T>(
this: T,
event: P,
listener: (...args: ListenerType<TEventRecord[P]>) => void,
): EEMethodReturnType<TEmitter, "once", T>;
once(event: typeof assignmentCompatibilityHack, listener: (...args: any[]) => any): void;
emit<P extends keyof TEmitRecord, T>(this: T, event: P, ...args: ListenerType<TEmitRecord[P]>): EEMethodReturnType<TEmitter, 'emit', T>;
emit<P extends keyof TEmitRecord, T>(
this: T,
event: P,
...args: ListenerType<TEmitRecord[P]>
): EEMethodReturnType<TEmitter, "emit", T>;
emit(event: typeof assignmentCompatibilityHack, ...args: any[]): void;
}
export type OverriddenKeys = keyof OverriddenMethods<any, any, any>;
export type StrictEventEmitter<TEmitterType, TEventRecord, TEmitRecord = TEventRecord, UnneededMethods extends Exclude<OverriddenKeys, keyof TEmitterType> =
Exclude<OverriddenKeys, keyof TEmitterType>, NeededMethods extends Exclude<OverriddenKeys, UnneededMethods> = Exclude<OverriddenKeys, UnneededMethods>> =
TypeRecord<TEmitterType, TEventRecord, TEmitRecord> & Pick<TEmitterType, Exclude<keyof TEmitterType, OverriddenKeys>> &
Pick<OverriddenMethods<TEmitterType, TEventRecord, TEmitRecord>, NeededMethods>;
export type StrictEventEmitter<
TEmitterType,
TEventRecord,
TEmitRecord = TEventRecord,
UnneededMethods extends Exclude<OverriddenKeys, keyof TEmitterType> = Exclude<OverriddenKeys, keyof TEmitterType>,
NeededMethods extends Exclude<OverriddenKeys, UnneededMethods> = Exclude<OverriddenKeys, UnneededMethods>,
> =
& TypeRecord<TEmitterType, TEventRecord, TEmitRecord>
& Pick<TEmitterType, Exclude<keyof TEmitterType, OverriddenKeys>>
& Pick<OverriddenMethods<TEmitterType, TEventRecord, TEmitRecord>, NeededMethods>;
export default StrictEventEmitter;
export type NoUndefined<T> = T extends undefined ? never : T;
export interface StrictBroadcast<TEmitter extends TypeRecord<any, any, any>,
TEmitRecord extends NoUndefined<TEmitter[' _emitType']> = NoUndefined<TEmitter[' _emitType']>,
VK extends VoidKeys<TEmitRecord> = VoidKeys<TEmitRecord>, NVK extends Exclude<keyof TEmitRecord, VK> = Exclude<keyof TEmitRecord, VK>> {
export interface StrictBroadcast<
TEmitter extends TypeRecord<any, any, any>,
TEmitRecord extends NoUndefined<TEmitter[" _emitType"]> = NoUndefined<TEmitter[" _emitType"]>,
VK extends VoidKeys<TEmitRecord> = VoidKeys<TEmitRecord>,
NVK extends Exclude<keyof TEmitRecord, VK> = Exclude<keyof TEmitRecord, VK>,
> {
<E extends NVK>(event: E, request: TEmitRecord[E]): any;
(event: VK): any;
}
export type EventNames<TEmitter extends TypeRecord<any, any, any>,
TEventRecord extends NoUndefined<TEmitter[' _eventsType']> = NoUndefined<TEmitter[' _eventsType']>,
TEmitRecord extends NoUndefined<TEmitter[' _emitType']> = NoUndefined<TEmitter[' _emitType']>> = keyof TEmitRecord | keyof TEventRecord;
export type OnEventNames<TEmitter extends TypeRecord<any, any, any>,
TEventRecord extends NoUndefined<TEmitter[' _eventsType']> = NoUndefined<TEmitter[' _eventsType']>,
TEmitRecord extends NoUndefined<TEmitter[' _emitType']> = NoUndefined<TEmitter[' _emitType']>> = keyof TEventRecord;
export type EmitEventNames<TEmitter extends TypeRecord<any, any, any>,
TEventRecord extends NoUndefined<TEmitter[' _eventsType']> = NoUndefined<TEmitter[' _eventsType']>,
TEmitRecord extends NoUndefined<TEmitter[' _emitType']> = NoUndefined<TEmitter[' _emitType']>> = keyof TEmitRecord;
export type EventNames<
TEmitter extends TypeRecord<any, any, any>,
TEventRecord extends NoUndefined<TEmitter[" _eventsType"]> = NoUndefined<TEmitter[" _eventsType"]>,
TEmitRecord extends NoUndefined<TEmitter[" _emitType"]> = NoUndefined<TEmitter[" _emitType"]>,
> = keyof TEmitRecord | keyof TEventRecord;
export type OnEventNames<
TEmitter extends TypeRecord<any, any, any>,
TEventRecord extends NoUndefined<TEmitter[" _eventsType"]> = NoUndefined<TEmitter[" _eventsType"]>,
TEmitRecord extends NoUndefined<TEmitter[" _emitType"]> = NoUndefined<TEmitter[" _emitType"]>,
> = keyof TEventRecord;
export type EmitEventNames<
TEmitter extends TypeRecord<any, any, any>,
TEventRecord extends NoUndefined<TEmitter[" _eventsType"]> = NoUndefined<TEmitter[" _eventsType"]>,
TEmitRecord extends NoUndefined<TEmitter[" _emitType"]> = NoUndefined<TEmitter[" _emitType"]>,
> = keyof TEmitRecord;
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc