Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NakiriClientOptions

Specifies the options of the Nakiri client.

property

{string} baseUrl - The base URL of the Nakiri API. If not provided, the default value is https://nakiri.one/api.

property

{boolean} useGateway - Whether or not to use the gateway. If not provided, the default value is true.

property

{boolean} useHTTP - Whether or not to use the HTTP client. If not provided, the default value is true.

property

{string} group - The ID of the group that the API key belongs to.

property

{number} gatewayReconnectInterval - The interval in milliseconds between reconnect attempts. If not provided, the default value is 10000. Must be a value greater than 10000. If set to 0, there will be no reconnect attempts.

Hierarchy

  • NakiriClientOptions

Index

Properties

Optional baseUrl

baseUrl?: string

Optional gatewayReconnectInterval

gatewayReconnectInterval?: number

Optional group

group?: string

Optional useGateway

useGateway?: boolean

Optional useHTTP

useHTTP?: boolean

Generated using TypeDoc