Class Client

Hierarchy

TypedEventEmitter<ClientEventTypes>
- Client

Index

Constructors

Properties

admin config host loginState note reaction removeAllListeners user

Methods

emit login off on once

Constructors

constructor

new Client(config): Client
Parameters
- config: ClientConfig
Returns Client
Overrides TypedEventEmitter.constructor
- Defined in src/client.ts:45

Properties

admin

admin: AdminManager

`Private` config

config: ClientConfig

host

host: string

loginState

loginState: boolean

note

note: NoteManager

reaction

reaction: ReactionManager

removeAllListeners

removeAllListeners: ((event?) => EventEmitter)

Type declaration

- (event?): EventEmitter
- Removes all listeners, or those of the specified eventName.
  
  It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
  
  Returns a reference to the EventEmitter, so that calls can be chained.
  Parameters
  - Optional event: string | symbol
  Returns EventEmitter
  
  Since
  v0.1.26

user

user: UserManager

Methods

emit

emit<TEventName>(eventName, ...eventArg): void
Type Parameters
- TEventName extends "follow" | "mention" | "ready" | "noteCreate" | "notification" | "reply" | "renote" | "followed" | "unfollow" | "unreadNotification" | "unreadMention" | "readAllUnreadMentions" | "unreadSpecifiedNote" | "readAllUnreadSpecifiedNotes"
Parameters
- eventName: TEventName
- Rest ...eventArg: ClientEventTypes[TEventName]
Returns void
Inherited from TypedEventEmitter.emit
- Defined in src/eventemitter.ts:10

login

login(): void
Returns void
- Defined in src/client.ts:56

off

off<TEventName>(eventName, handler): void
Type Parameters
- TEventName extends "follow" | "mention" | "ready" | "noteCreate" | "notification" | "reply" | "renote" | "followed" | "unfollow" | "unreadNotification" | "unreadMention" | "readAllUnreadMentions" | "unreadSpecifiedNote" | "readAllUnreadSpecifiedNotes"
Parameters
- eventName: TEventName
- handler: ((...eventArg) => void)
  - - (...eventArg): void
    - Parameters
      
      Rest ...eventArg: ClientEventTypes[TEventName]
      
      Returns void
Returns void
Inherited from TypedEventEmitter.off
- Defined in src/eventemitter.ts:31

on

on<TEventName>(eventName, handler): void
Type Parameters
- TEventName extends "follow" | "mention" | "ready" | "noteCreate" | "notification" | "reply" | "renote" | "followed" | "unfollow" | "unreadNotification" | "unreadMention" | "readAllUnreadMentions" | "unreadSpecifiedNote" | "readAllUnreadSpecifiedNotes"
Parameters
- eventName: TEventName
- handler: ((...eventArg) => void)
  - - (...eventArg): void
    - Parameters
      
      Rest ...eventArg: ClientEventTypes[TEventName]
      
      Returns void
Returns void
Inherited from TypedEventEmitter.on
- Defined in src/eventemitter.ts:17

once

once<TEventName>(eventName, handler): void
Type Parameters
- TEventName extends "follow" | "mention" | "ready" | "noteCreate" | "notification" | "reply" | "renote" | "followed" | "unfollow" | "unreadNotification" | "unreadMention" | "readAllUnreadMentions" | "unreadSpecifiedNote" | "readAllUnreadSpecifiedNotes"
Parameters
- eventName: TEventName
- handler: ((...eventArt) => void)
  - - (...eventArt): void
    - Parameters
      
      Rest ...eventArt: ClientEventTypes[TEventName]
      
      Returns void
Returns void
Inherited from TypedEventEmitter.once
- Defined in src/eventemitter.ts:24

Generated using TypeDoc