Class Friend

Hierarchy

Contactable
Hierarchy
- Friend

Index

Constructors

constructor

new Friend(c: Client, uid: number): Friend
Parameters
- c: Client
- uid: number
Returns Friend
Overrides Contactable.constructor
- Defined in src/friend.ts:60

Properties

c

c: Client

`Protected` `Optional` group_id

group_id?: number

info

info: FriendInfo

maxListeners

maxListeners: number

`Protected` `Optional` user_id

user_id?: number

Accessors

client

get client(): Client
Returns Client
Inherited from Contactable.client
- Defined in src/contactable.ts:10

Methods

addEventListener

addEventListener<E>(event: E, listener: FriendEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof FriendEventMap
Parameters
- event: E
- listener: FriendEventMap[E]
- Optional prepend: boolean
Returns Dispose
- Defined in src/friend.ts:90
addEventListener<S>(event: S & Exclude<S, keyof FriendEventMap>, listener: ((...args: any) => any), prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends string | symbol
Parameters
- event: S & Exclude<S, keyof FriendEventMap>
- listener: ((...args: any) => any)
  - - (...args: any): any
    - Parameters
      
      Rest ...args: any
      
      Returns any
- Optional prepend: boolean
Returns Dispose
- Defined in src/friend.ts:91

addListener

addListener(event: EventName, listener: Listener, prepend?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.addListener
- Defined in node_modules/event-deliver/lib/index.d.ts:10

addOnceEventListener

addOnceEventListener<E>(event: E, listener: FriendEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof FriendEventMap
Parameters
- event: E
- listener: FriendEventMap[E]
- Optional prepend: boolean
Returns Dispose
- Defined in src/friend.ts:96
addOnceEventListener<S>(event: S & Exclude<S, keyof FriendEventMap>, listener: ((...args: any) => any), prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends string | symbol
Parameters
- event: S & Exclude<S, keyof FriendEventMap>
- listener: ((...args: any) => any)
  - - (...args: any): any
    - Parameters
      
      Rest ...args: any
      
      Returns any
- Optional prepend: boolean
Returns Dispose
- Defined in src/friend.ts:97

addOnceListener

addOnceListener(event: EventName, listener: Listener, prepend?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.addOnceListener
- Defined in node_modules/event-deliver/lib/index.d.ts:12

after

after(event: string, listener: Listener): Dispose
Parameters
- event: string
- listener: Listener
Returns Dispose
Inherited from Contactable.after
- Defined in node_modules/event-deliver/lib/index.d.ts:20

bail

bail(event: EventName, ...args: any[]): any
Parameters
- event: EventName
- Rest ...args: any[]
Returns any
Inherited from Contactable.bail
- Defined in node_modules/event-deliver/lib/index.d.ts:22

bailSync

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

before

before(event: string, listener: Listener): Dispose
Parameters
- event: string
- listener: Listener
Returns Dispose
Inherited from Contactable.before
- Defined in node_modules/event-deliver/lib/index.d.ts:19

delete

delete(): Promise<MessageRet>
Returns Promise<MessageRet>
- Defined in src/friend.ts:72

em

em(name: string, data: any): void
Parameters
- name: string
- data: any
Returns void
Inherited from Contactable.em
- Defined in src/contactable.ts:13

emit

emit<E>(event: E, ...args: FriendEventMap[E] extends ((...args: P) => any) ? P : never[]): boolean
Type Parameters
Type Parameters
- E extends keyof FriendEventMap
Parameters
- event: E
- Rest ...args: FriendEventMap[E] extends ((...args: P) => any) ? P : never[]
Returns boolean
Inherited from Contactable.emit
- Defined in src/friend.ts:103
emit<S>(event: S & Exclude<S, keyof FriendEventMap>, ...args: any): boolean
Type Parameters
Type Parameters
- S extends string | symbol
Parameters
- event: S & Exclude<S, keyof FriendEventMap>
- Rest ...args: any
Returns boolean
Inherited from Contactable.emit
- Defined in src/friend.ts:104

emitAsync

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

eventNames

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

getMaxListeners

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

listenerCount

listenerCount(event: EventName): number
Parameters
- event: EventName
Returns number
Inherited from Contactable.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 Contactable.listeners
- Defined in node_modules/event-deliver/lib/index.d.ts:8

off

off<E>(event?: E, listener?: FriendEventMap[E]): boolean
Type Parameters
Type Parameters
- E extends keyof FriendEventMap
Parameters
- Optional event: E
- Optional listener: FriendEventMap[E]
Returns boolean
Inherited from Contactable.off
- Defined in src/friend.ts:99
off<S>(event?: S & Exclude<S, keyof FriendEventMap>, listener?: ((...args: any) => any)): boolean
Type Parameters
Type Parameters
- S extends string | symbol
Parameters
- Optional event: S & Exclude<S, keyof FriendEventMap>
- Optional listener: ((...args: any) => any)
  - - (...args: any): any
    - Parameters
      
      Rest ...args: any
      
      Returns any
Returns boolean
Inherited from Contactable.off
- Defined in src/friend.ts:100

on

on<E>(event: E, listener: FriendEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof FriendEventMap
Parameters
- event: E
- listener: FriendEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.on
- Defined in src/friend.ts:88
on<S>(event: S & Exclude<S, keyof FriendEventMap>, listener: ((...args: any) => any), prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends string | symbol
Parameters
- event: S & Exclude<S, keyof FriendEventMap>
- listener: ((...args: any) => any)
  - - (...args: any): any
    - Parameters
      
      Rest ...args: any
      
      Returns any
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.on
- Defined in src/friend.ts:89

once

once<E>(event: E, listener: FriendEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof FriendEventMap
Parameters
- event: E
- listener: FriendEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.once
- Defined in src/friend.ts:94
once<S>(event: S & Exclude<S, keyof FriendEventMap>, listener: ((...args: any) => any), prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends string | symbol
Parameters
- event: S & Exclude<S, keyof FriendEventMap>
- listener: ((...args: any) => any)
  - - (...args: any): any
    - Parameters
      
      Rest ...args: any
      
      Returns any
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.once
- Defined in src/friend.ts:95

prependEventListener

prependEventListener<E>(event: E, listener: FriendEventMap[E], append?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof FriendEventMap
Parameters
- event: E
- listener: FriendEventMap[E]
- Optional append: boolean
Returns Dispose
- Defined in src/friend.ts:92
prependEventListener<S>(event: S & Exclude<S, keyof FriendEventMap>, listener: ((...args: any) => any), append?: boolean): Dispose
Type Parameters
Type Parameters
- S extends string | symbol
Parameters
- event: S & Exclude<S, keyof FriendEventMap>
- listener: ((...args: any) => any)
  - - (...args: any): any
    - Parameters
      
      Rest ...args: any
      
      Returns any
- Optional append: boolean
Returns Dispose
- Defined in src/friend.ts:93

prependListener

prependListener(event: EventName, listener: Listener, append?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional append: boolean
Returns Dispose
Inherited from Contactable.prependListener
- Defined in node_modules/event-deliver/lib/index.d.ts:11

prependOnceEventListener

prependOnceEventListener<E>(event: E, listener: FriendEventMap[E], append?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof FriendEventMap
Parameters
- event: E
- listener: FriendEventMap[E]
- Optional append: boolean
Returns Dispose
- Defined in src/friend.ts:98

prependOnceListener

prependOnceListener(event: EventName, listener: Listener, append?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional append: boolean
Returns Dispose
Inherited from Contactable.prependOnceListener
- Defined in node_modules/event-deliver/lib/index.d.ts:14

removeEventListener

removeEventListener<E>(event: E, listener?: FriendEventMap[E]): Dispose
Type Parameters
Type Parameters
- E extends keyof FriendEventMap
Parameters
- event: E
- Optional listener: FriendEventMap[E]
Returns Dispose
- Defined in src/friend.ts:101
removeEventListener<S>(event: S & Exclude<S, keyof FriendEventMap>, listener?: ((...args: any) => any)): Dispose
Type Parameters
Type Parameters
- S extends string | symbol
Parameters
- event: S & Exclude<S, keyof FriendEventMap>
- Optional listener: ((...args: any) => any)
  - - (...args: any): any
    - Parameters
      
      Rest ...args: any
      
      Returns any
Returns Dispose
- Defined in src/friend.ts:102

removeListener

removeListener(event?: EventName, listener?: Listener): boolean
Parameters
- Optional event: EventName
- Optional listener: Listener
Returns boolean
Inherited from Contactable.removeListener
- Defined in node_modules/event-deliver/lib/index.d.ts:15

sendMsg

sendMsg(message: Sendable, quote?: Quotable): Promise<MessageRet>
Parameters
- message: Sendable
- Optional quote: Quotable
Returns Promise<MessageRet>
- Defined in src/friend.ts:82

setMaxListeners

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

uploadFile

uploadFile(file: string, name: string): Promise<MessageRet>
Parameters
- file: string
- name: string
Returns Promise<MessageRet>
- Defined in src/friend.ts:75

`Static` as

as(this: Client, uid: number): Friend
Parameters
- this: Client
- uid: number
Returns Friend
- Defined in src/friend.ts:66

Class Friend

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

c: Client

uid: number

Returns Friend

Properties

c

Protected Optional group_id

info

maxListeners

Protected Optional user_id

Accessors

client

Returns Client

Methods

addEventListener

Type Parameters

Type Parameters

E extends keyof FriendEventMap

Parameters

event: E

listener: FriendEventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends string | symbol

Parameters

event: S & Exclude<S, keyof FriendEventMap>

listener: ((...args: any) => any)

Parameters

Rest ...args: any

Returns any

Optional prepend: boolean

Returns Dispose

addListener

Parameters

event: EventName

listener: Listener

Optional prepend: boolean

Returns Dispose

addOnceEventListener

Type Parameters

Type Parameters

E extends keyof FriendEventMap

Parameters

event: E

listener: FriendEventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends string | symbol

Parameters

event: S & Exclude<S, keyof FriendEventMap>

listener: ((...args: any) => any)

Parameters

Rest ...args: any

Returns any

Optional prepend: boolean

Returns Dispose

addOnceListener

Parameters

event: EventName

listener: Listener

Optional prepend: boolean

Returns Dispose

after

Parameters

event: string

listener: Listener

`Protected` `Optional` group_id

`Protected` `Optional` user_id

`Optional` prepend: boolean

`Rest` ...args: any

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Rest` ...args: any

`Optional` prepend: boolean

`Optional` prepend: boolean

`Rest` ...args: any[]

`Rest` ...args: any[]

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

`Rest` ...args: any

`Rest` ...args: any[]

`Optional` event: EventName

`Optional` event: E

`Optional` listener: FriendEventMap[E]

`Optional` event: S & Exclude<S, keyof FriendEventMap>

`Optional` listener: ((...args: any) => any)