Class Client

Hierarchy

EventDeliver
Hierarchy
- Client

Constructors

constructor

new Client(uin: number, options?: string | Options): Client
Parameters
- uin: number
- Optional options: string | Options
Returns Client
Overrides EventDeliver.constructor
- Defined in src/client.ts:73

Properties

`Readonly` fl

fl: Map<number, FriendInfo> = ...

`Readonly` gl

gl: Map<number, GroupInfo> = ...

`Readonly` gml

gml: Map<number, Map<number, MemberInfo>> = ...

link

link: Link

maxListeners

maxListeners: number

options

options: Options

`Readonly` pickFriend

pickFriend: ((...args: [uid: number]) => Friend) = ...

Type declaration

- (...args: [uid: number]): Friend
- 得到一个好友对象, 通常不会重复创建
  Parameters
  - Rest ...args: [uid: number]
  Returns Friend

`Readonly` pickGroup

pickGroup: ((...args: [group_id: number]) => Group) = ...

Type declaration

- (...args: [group_id: number]): Group
- Parameters
  - Rest ...args: [group_id: number]
  Returns Group

`Readonly` pickMember

pickMember: ((...args: [gid: number, uid: number]) => Member) = ...

Type declaration

- (...args: [gid: number, uid: number]): Member
- 得到一个群员对象, 通常不会重复创建
  Parameters
  - Rest ...args: [gid: number, uid: number]
  Returns Member

`Readonly` pickUser

pickUser: ((...args: [uid: number]) => User) = ...

Type declaration

- (...args: [uid: number]): User
- 创建一个用户对象
  Parameters
  - Rest ...args: [uid: number]
  Returns User

uin

uin: number

Methods

`Private` #init

#init(): Promise<void>
Returns Promise<void>
- Defined in src/client.ts:155

addListener

addListener<E>(event: E, listener: EventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.addListener
- Defined in src/client.ts:211
addListener<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.addListener
- Defined in src/client.ts:212

addOnceListener

addOnceListener<E>(event: E, listener: EventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.addOnceListener
- Defined in src/client.ts:217
addOnceListener<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.addOnceListener
- Defined in src/client.ts:218

after

after<E>(event: E, listener: EventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.after
- Defined in src/client.ts:207
after<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.after
- Defined in src/client.ts:208
after<E>(event: E, listener: EventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.after
- Defined in src/client.ts:223
after<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.after
- Defined in src/client.ts:224

bail

bail<E>(event: E, ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]): Promise<any>
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- Rest ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]
Returns Promise<any>
Inherited from EventDeliver.bail
- Defined in src/client.ts:233
bail<S>(event: S & Exclude<S, keyof EventMap>, ...args: any[]): Promise<any>
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- Rest ...args: any[]
Returns Promise<any>
Inherited from EventDeliver.bail
- Defined in src/client.ts:234

bailSync

bailSync<E>(event: E, ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]): Promise<any>
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- Rest ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]
Returns Promise<any>
Inherited from EventDeliver.bailSync
- Defined in src/client.ts:235
bailSync<S>(event: S & Exclude<S, keyof EventMap>, ...args: any[]): Promise<any>
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- Rest ...args: any[]
Returns Promise<any>
Inherited from EventDeliver.bailSync
- Defined in src/client.ts:236

before

before<E>(event: E, listener: EventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.before
- Defined in src/client.ts:205
before<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.before
- Defined in src/client.ts:206
before<E>(event: E, listener: EventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.before
- Defined in src/client.ts:221
before<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.before
- Defined in src/client.ts:222

canSendImage

canSendImage(): Promise<{ yes: boolean }>
Returns Promise<{ yes: boolean }>
- Defined in src/client.ts:58

canSendRecord

canSendRecord(): Promise<{ yes: boolean }>
Returns Promise<{ yes: boolean }>
- Defined in src/client.ts:61

cleanServerCache

cleanServerCache(): Promise<void>
Returns Promise<void>
- Defined in src/client.ts:70

deleteMsg

deleteMsg(message_id: string): Promise<any>
Parameters
- message_id: string
Returns Promise<any>
- Defined in src/client.ts:28

em

em(name: string, data: any): void
Parameters
- name: string
- data: any
Returns void
- Defined in src/client.ts:178

emit

emit<E>(event: E, ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]): void
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- Rest ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]
Returns void
Inherited from EventDeliver.emit
- Defined in src/client.ts:229
emit<S>(event: S & Exclude<S, keyof EventMap>, ...args: any[]): void
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- Rest ...args: any[]
Returns void
Inherited from EventDeliver.emit
- Defined in src/client.ts:230

emitAsync

emitAsync(event: EventName, ...args: any[]): Promise<void>
Parameters
- event: EventName
- Rest ...args: any[]
Returns Promise<void>
Inherited from EventDeliver.emitAsync
- Defined in node_modules/event-deliver/lib/index.d.ts:17

emitSync

emitSync<E>(event: E, ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]): void
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- Rest ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]
Returns void
- Defined in src/client.ts:231
emitSync<S>(event: S & Exclude<S, keyof EventMap>, ...args: any[]): void
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- Rest ...args: any[]
Returns void
- Defined in src/client.ts:232

eventNames

eventNames(): EventName[]
Returns EventName[]
Inherited from EventDeliver.eventNames
- Defined in node_modules/event-deliver/lib/index.d.ts:24

getFriendList

getFriendList(): Promise<FriendInfo[]>
Returns Promise<FriendInfo[]>
- Defined in src/client.ts:40

getGroupList

getGroupList(): Promise<GroupInfo[]>
Returns Promise<GroupInfo[]>
- Defined in src/client.ts:43

getGroupMemberList

getGroupMemberList(group_id: number): Promise<MemberInfo[]>
Parameters
- group_id: number
Returns Promise<MemberInfo[]>
- Defined in src/client.ts:46

getImage

getImage(file: string): Promise<{ filename: string; size: number; url: string }>
Parameters
- file: string
Returns Promise<{ filename: string; size: number; url: string }>
- Defined in src/client.ts:52

getInfo

getInfo(): Promise<{ nickname: string; user_id: number }>
Returns Promise<{ nickname: string; user_id: number }>
- Defined in src/client.ts:31

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from EventDeliver.getMaxListeners
- Defined in node_modules/event-deliver/lib/index.d.ts:7

getMsg

getMsg(message_id: string): Promise<Omit<Message, "reply">>
Parameters
- message_id: string
Returns Promise<Omit<Message, "reply">>
- Defined in src/client.ts:49

getRecord

getRecord(file: string, out_format?: "mp3" | "amr" | "wma" | "m4a" | "spx" | "ogg" | "wav" | "flac"): Promise<{ file: string }>
Parameters
- file: string
- out_format: "mp3" | "amr" | "wma" | "m4a" | "spx" | "ogg" | "wav" | "flac" = 'mp3'
Returns Promise<{ file: string }>
- Defined in src/client.ts:55

getStrangerInfo

getStrangerInfo(user_id: number): Promise<StrangerInfo>
Parameters
- user_id: number
Returns Promise<StrangerInfo>
- Defined in src/client.ts:37

getVersionInfo

getVersionInfo(): Promise<VersionInfo>
Returns Promise<VersionInfo>
- Defined in src/client.ts:64

listenerCount

listenerCount(event: EventName): number
Parameters
- event: EventName
Returns number
Inherited from EventDeliver.listenerCount
- Defined in node_modules/event-deliver/lib/index.d.ts:23

listeners

listeners(event?: EventName): Listener[]
Parameters
- Optional event: EventName
Returns Listener[]
Inherited from EventDeliver.listeners
- Defined in node_modules/event-deliver/lib/index.d.ts:8

off

off<E>(event?: E, listener?: EventMap[E]): boolean
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- Optional event: E
- Optional listener: EventMap[E]
Returns boolean
Inherited from EventDeliver.off
- Defined in src/client.ts:225
off<S>(event?: S & Exclude<S, keyof EventMap>, listener?: Listener): boolean
Type Parameters
Type Parameters
- S extends EventName
Parameters
- Optional event: S & Exclude<S, keyof EventMap>
- Optional listener: Listener
Returns boolean
Inherited from EventDeliver.off
- Defined in src/client.ts:226

on

on<E>(event: E, listener: EventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.on
- Defined in src/client.ts:209
on<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.on
- Defined in src/client.ts:210

once

once<E>(event: E, listener: EventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.once
- Defined in src/client.ts:215
once<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from EventDeliver.once
- Defined in src/client.ts:216

prependListener

prependListener<E>(event: E, listener: EventMap[E], append?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional append: boolean
Returns Dispose
Inherited from EventDeliver.prependListener
- Defined in src/client.ts:213
prependListener<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, append?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional append: boolean
Returns Dispose
Inherited from EventDeliver.prependListener
- Defined in src/client.ts:214

prependOnceListener

prependOnceListener<E>(event: E, listener: EventMap[E], append?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- event: E
- listener: EventMap[E]
- Optional append: boolean
Returns Dispose
Inherited from EventDeliver.prependOnceListener
- Defined in src/client.ts:219
prependOnceListener<S>(event: S & Exclude<S, keyof EventMap>, listener: Listener, append?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof EventMap>
- listener: Listener
- Optional append: boolean
Returns Dispose
Inherited from EventDeliver.prependOnceListener
- Defined in src/client.ts:220

removeListener

removeListener<E>(event?: E, listener?: EventMap[E]): boolean
Type Parameters
Type Parameters
- E extends keyof EventMap
Parameters
- Optional event: E
- Optional listener: EventMap[E]
Returns boolean
Inherited from EventDeliver.removeListener
- Defined in src/client.ts:227
removeListener<S>(event?: S & Exclude<S, keyof EventMap>, listener?: Listener): boolean
Type Parameters
Type Parameters
- S extends EventName
Parameters
- Optional event: S & Exclude<S, keyof EventMap>
- Optional listener: Listener
Returns boolean
Inherited from EventDeliver.removeListener
- Defined in src/client.ts:228

restartServer

restartServer(): Promise<void>
Returns Promise<void>
- Defined in src/client.ts:67

sendGroupMsg

sendGroupMsg(group_id: number, message: Sendable, source?: Quotable): Promise<MessageRet>
Parameters
- group_id: number
- message: Sendable
- Optional source: Quotable
Returns Promise<MessageRet>
- Defined in src/client.ts:175

sendPrivateMsg

sendPrivateMsg(user_id: number, message: Sendable, source?: Quotable): Promise<MessageRet>
Parameters
- user_id: number
- message: Sendable
- Optional source: Quotable
Returns Promise<MessageRet>
- Defined in src/client.ts:172

setMaxListeners

setMaxListeners(n: number): Client
Parameters
- n: number
Returns Client
Inherited from EventDeliver.setMaxListeners
- Defined in node_modules/event-deliver/lib/index.d.ts:5

setProfile

setProfile(profile: Partial<Profile>): Promise<void>
Parameters
- profile: Partial<Profile>
Returns Promise<void>
- Defined in src/client.ts:34

start

start(): Promise<void>
Returns Promise<void>
- Defined in src/client.ts:84

stop

stop(): void
Returns void
- Defined in src/client.ts:193

Class Client

Hierarchy

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

uin: number

Optional options: string | Options

Returns Client

Properties

Readonly fl

Readonly gl

Readonly gml

link

maxListeners

options

Readonly pickFriend

Type declaration

Parameters

Rest ...args: [uid: number]

Returns Friend

Readonly pickGroup

Type declaration

Parameters

Rest ...args: [group_id: number]

Returns Group

Readonly pickMember

Type declaration

Parameters

Rest ...args: [gid: number, uid: number]

Returns Member

Readonly pickUser

Type declaration

Parameters

Rest ...args: [uid: number]

Returns User

uin

Methods

Private #init

Returns Promise<void>

addListener

Type Parameters

Type Parameters

E extends keyof EventMap

Parameters

event: E

listener: EventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends EventName

Parameters

event: S & Exclude<S, keyof EventMap>

listener: Listener

Optional prepend: boolean

Returns Dispose

addOnceListener

Type Parameters

Type Parameters

E extends keyof EventMap

Parameters

event: E

listener: EventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends EventName

Parameters

event: S & Exclude<S, keyof EventMap>

listener: Listener

Optional prepend: boolean

Returns Dispose

after

Type Parameters

`Optional` options: string | Options

`Readonly` fl

`Readonly` gl

`Readonly` gml

`Readonly` pickFriend

`Rest` ...args: [uid: number]

`Readonly` pickGroup

`Rest` ...args: [group_id: number]

`Readonly` pickMember

`Rest` ...args: [gid: number, uid: number]

`Readonly` pickUser

`Rest` ...args: [uid: number]

`Private` #init

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Rest` ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]

`Rest` ...args: any[]

`Rest` ...args: EventMap[E] extends ((...args: P) => any) ? P : never[]

`Rest` ...args: any[]

`Optional` prepend: boolean