andesitejs / Exports / api/types / NodeOptions

Interface: NodeOptions

api/types.NodeOptions

Hierarchy

• NodeOptions

Table of contents

Properties

• auth
• eventBuffer
• host
• id
• pingInterval
• port
• reconnection
• secure

Properties

auth

• Optional auth: undefined | string

The authorization used for connecting. You can omit this if you didn't set a password.

Defined in: api/types.ts:720

---

eventBuffer

• Optional eventBuffer: undefined | number

When a connection is closed, events will be buffered for up to the timeout specified.

Defined in: api/types.ts:740

---

host

• host: string

The host name of the node.

Defined in: api/types.ts:710

---

id

• Optional id: undefined | string | number

The identifier for this node..

Defined in: api/types.ts:725

---

pingInterval

• Optional pingInterval: undefined | number

How often to ping the andesite instance, in milliseconds. This can be omitted if you do not want to ping the node.

Defined in: api/types.ts:735

---

port

• port: string | number

The port that the node is on.

Defined in: api/types.ts:715

---

reconnection

• Optional reconnection: undefined | ReconnectionOptions

The reconnection options for this node.

Defined in: api/types.ts:745

---

secure

• Optional secure: undefined | boolean

Whether to use https/wss.

Defined in: api/types.ts:730