Client | node-nakiri

api: public

Hierarchy

Client

Index

Constructors

constructor

Properties

baseUrl

Methods

Constructors

constructor

new Client(opts?: NakiriClientOptions): Client

- Defined in index.ts:60
Parameters
- opts: NakiriClientOptions = {}
  
  The options of the Nakiri client.
Returns Client

Properties

Readonly baseUrl

baseUrl: string

Methods

addDiscordGuild

addDiscordGuild(data: NakiriHTTPAddDiscordGuildEntryRequest, opts?: NakiriPostRequestOptions): Promise<any>

- Defined in index.ts:535
Adds a Discord guild ID to the blacklist.

Parameters
- data: NakiriHTTPAddDiscordGuildEntryRequest
  
  The request body.
- Optional opts: NakiriPostRequestOptions
  
  The options which will be used for the request.
Returns Promise<any>

addLinkPattern

addLinkPattern(data: NakiriHTTPAddLinkPatternEntryRequest, opts?: NakiriPostRequestOptions): Promise<any>

- Defined in index.ts:521
Adds a link pattern to the blacklist.

Parameters
- data: NakiriHTTPAddLinkPatternEntryRequest
  
  The request body.
- Optional opts: NakiriPostRequestOptions
  
  The options which will be used for the request.
Returns Promise<any>

addPhrase

addPhrase(data: NakiriHTTPAddPhraseEntryRequest, opts?: NakiriPostRequestOptions): Promise<any>

- Defined in index.ts:549
Adds a phrase to the blacklist.

Parameters
- data: NakiriHTTPAddPhraseEntryRequest
  
  The request body.
- Optional opts: NakiriPostRequestOptions
  
  The options which will be used for the request.
Returns Promise<any>

addYouTubeChannel

addYouTubeChannel(data: NakiriHTTPAddYouTubeChannelEntryRequest, opts?: NakiriPostRequestOptions): Promise<any>

- Defined in index.ts:507
Adds a YouTube channel ID to the blacklist.

Parameters
- data: NakiriHTTPAddYouTubeChannelEntryRequest
  
  The request body.
- Optional opts: NakiriPostRequestOptions
  
  The options which will be used for the request.
Returns Promise<any>

addYouTubeVideo

addYouTubeVideo(data: NakiriHTTPAddYouTubeVideoEntryRequest, opts?: NakiriPostRequestOptions): Promise<any>

- Defined in index.ts:493
Adds a YouTube video ID to the blacklist.

Parameters
- data: NakiriHTTPAddYouTubeVideoEntryRequest
  
  The request body.
- Optional opts: NakiriPostRequestOptions
  
  The options which will be used for the request.
Returns Promise<any>

analyze

analyze(req: AnalysisRequest): void

- Defined in index.ts:258
Will request the analysis of a message. You should listen to the analysis notification for the result. This method will NOT return the analysis result right away, as it's an asynchronous operation.

Parameters
- req: AnalysisRequest
Returns void

attemptToReconnect

attemptToReconnect(): Promise<void>

- Defined in index.ts:266
Returns Promise<void>

emit

emit<T>(event: string, data?: T): void

- Defined in index.ts:246
Will emit an event, if it exists. Otherwise it will do nothing.

Type parameters
- T = any
Parameters
- event: string
  
  The event name.
- Optional data: T
  
  The data which will be passed to the event handler.
Returns void

getDiscordGuilds

getDiscordGuilds(opts?: NakiriRequestOptions): Promise<(string | DiscordGuild)[]>

- Defined in index.ts:412
Will get a list of blacklisted Discord guilds.

Parameters
- Optional opts: NakiriRequestOptions
  
  The options which will be used for the request.
Returns Promise<(string | DiscordGuild)[]>
The list of blacklisted Discord guilds.

getLinkPatterns

getLinkPatterns(opts?: NakiriRequestOptions): Promise<(string | LinkPattern)[]>

- Defined in index.ts:394
Will get a list of blacklisted link patterns.

Parameters
- Optional opts: NakiriRequestOptions
  
  The options which will be used for the request.
Returns Promise<(string | LinkPattern)[]>
The list of blacklisted link patterns.

getPhrases

getPhrases(opts?: NakiriRequestOptions): Promise<(string | Phrase)[]>

- Defined in index.ts:430
Will get a list of blacklisted phrases.

Parameters
- Optional opts: NakiriRequestOptions
  
  The options which will be used for the request.
Returns Promise<(string | Phrase)[]>
The list of blacklisted phrases.

getYouTubeChannels

getYouTubeChannels(opts?: NakiriRequestOptions): Promise<(string | YouTubeChannel)[]>

- Defined in index.ts:376
Will get a list of blacklisted YouTube channels.

Parameters
- Optional opts: NakiriRequestOptions
  
  The options which will be used for the request.
Returns Promise<(string | YouTubeChannel)[]>
The list of blacklisted YouTube channels.

getYouTubeVideos

getYouTubeVideos(opts?: NakiriRequestOptions): Promise<(string | YouTubeVideo)[]>

- Defined in index.ts:358
Will get a list of blacklisted YouTube videos.

Parameters
- Optional opts: NakiriRequestOptions
  
  The options which will be used for the request.
Returns Promise<(string | YouTubeVideo)[]>
The list of blacklisted YouTube videos.

login

- Defined in index.ts:131
Method used to authenticate to the Nakiri Gateway and set the API key to be used for HTTP requests.

Parameters
- apiKey: string
  
  The API key which will be used for authentication.
Returns Promise<void>

off

off(event: string): void

- Defined in index.ts:237
Unregisters an event handler.

Parameters
- event: string
  
  The event name.
Returns void

on

on(event: "error", handler: GatewayEventHandler<GatewayError>): void
on(event: "entryAdded", handler: GatewayEventHandler<BlacklistMutationData>): void
on(event: "entryRemoved", handler: GatewayEventHandler<BlacklistMutationData>): void
on(event: "analysis", handler: GatewayEventHandler<AnalysisNotification>): void
on(event: "ready", handler: GatewayEventHandler<GatewayIdentifyResponse>): void
on(event: "reconnect", handler: GatewayEventHandler<GatewayReconnectResponse>): void

- Defined in index.ts:164
Error event handler. Will fire when the Gateway emits an error.

Parameters
- event: "error"
  
  The event name.
- handler: GatewayEventHandler<GatewayError>
  
  The event handler.
Returns void
- Defined in index.ts:174
Entry Added event handler. Will fire when the Gateway sends a notification about the addition of a new entry.

Parameters
- event: "entryAdded"
  
  The event name.
- handler: GatewayEventHandler<BlacklistMutationData>
  
  The event handler.
Returns void
- Defined in index.ts:187
Entry Removed event handler. Will fire when the Gateway sends a notification about the removal of an entry.

Parameters
- event: "entryRemoved"
  
  The event name.
- handler: GatewayEventHandler<BlacklistMutationData>
  
  The event handler.
Returns void
- Defined in index.ts:192
Generic event handler.

Parameters
- event: "analysis"
  
  The event name.
- handler: GatewayEventHandler<AnalysisNotification>
  
  The event handler.
Returns void
- Defined in index.ts:205
Ready event handler. Will fire when the Gateway was successfully authenticated and a session has been established.

Parameters
- event: "ready"
  
  The event name.
- handler: GatewayEventHandler<GatewayIdentifyResponse>
  
  The event handler.
Returns void
- Defined in index.ts:217
Reconnect event handler. Will fire on successful Gateway reconnection and authentication.

Parameters
- event: "reconnect"
  
  The event name.
- handler: GatewayEventHandler<GatewayReconnectResponse>
  
  The event handler.
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

opts: NakiriClientOptions = {}

Returns Client

Properties

Readonly baseUrl

Methods

addDiscordGuild

Parameters

data: NakiriHTTPAddDiscordGuildEntryRequest

Optional opts: NakiriPostRequestOptions

Returns Promise<any>

addLinkPattern

Parameters

data: NakiriHTTPAddLinkPatternEntryRequest

Optional opts: NakiriPostRequestOptions

Returns Promise<any>

addPhrase

Parameters

data: NakiriHTTPAddPhraseEntryRequest

Optional opts: NakiriPostRequestOptions

Returns Promise<any>

addYouTubeChannel

Parameters

data: NakiriHTTPAddYouTubeChannelEntryRequest

Optional opts: NakiriPostRequestOptions

Returns Promise<any>

addYouTubeVideo

Parameters

data: NakiriHTTPAddYouTubeVideoEntryRequest

Optional opts: NakiriPostRequestOptions

Returns Promise<any>

analyze

Parameters

req: AnalysisRequest

Returns void

attemptToReconnect

Returns Promise<void>

emit

Type parameters

T = any

Parameters

event: string

Optional data: T

Returns void

getDiscordGuilds

Parameters

Optional opts: NakiriRequestOptions

Returns Promise<(string | DiscordGuild)[]>

getLinkPatterns

Parameters

Optional opts: NakiriRequestOptions

Returns Promise<(string | LinkPattern)[]>

getPhrases

Parameters

Optional opts: NakiriRequestOptions

Returns Promise<(string | Phrase)[]>

getYouTubeChannels

Parameters

Optional opts: NakiriRequestOptions

Returns Promise<(string | YouTubeChannel)[]>

getYouTubeVideos

Parameters

Optional opts: NakiriRequestOptions

Returns Promise<(string | YouTubeVideo)[]>

login

Parameters

apiKey: string

Returns Promise<void>

off

Parameters

event: string

Returns void

on