Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/sdk/js/6/core-classes/kuzzle/properties/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,19 @@ order: 10

| Property name | Type | Description |
| -------------------- | -------- | ---------------------|
| `authenticated` | <pre>boolean</pre> | Returns `true` if the SDK holds a valid token |
| `connected` | <pre>boolean</pre> | Returns `true` if the SDK is currently connected to a Kuzzle server. |
| `offlineQueue` | <pre>object[]</pre> | Contains the queued requests during offline mode |
| `protocol` | <pre>Protocol</pre> | Protocol used by the SDK |

### connected

The `connected` property wraps the underlying protocol `connected` property.
See the associated documentation:
- [Http.connected](/sdk/js/6/protocols/http/properties)
- [WebSocket.connected](/sdk/js/6/protocols/websocket/properties)
- [SocketIO.connected](/sdk/js/6/protocols/socketio/properties)

# Writable properties

| Property name | Type | Description |
Expand Down
19 changes: 19 additions & 0 deletions src/sdk/js/6/protocols/http/properties/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
code: false
type: page
title: Properties
description: Http class properties
order: 10
---


# Properties

| Property name | Type | Description |
| -------------------- | -------- | ---------------------|
| `connected` | <pre>boolean</pre> | Always returns `true` |
| `host` | <pre>string</pre> | Kuzzle server host |
| `http` | <pre>object</pre> | Returns a list of available routes |
| `port` | <pre>number</pre> | Kuzzle server port |
| `protocol` | <pre>string</pre> | `https` or `http` |
| `ssl` | <pre>boolean</pre> | `true` if ssl is active |
8 changes: 6 additions & 2 deletions src/sdk/js/6/protocols/socketio/properties/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ order: 10

| Property name | Type | Description |
| -------------------- | -------- | ---------------------|
| `autoReconnect` | <pre>boolean</pre> | Automatically reconnect after a connection loss |
| `autoReconnect` | <pre>boolean</pre> | Automatically reconnects after a connection loss |
| `connected` | <pre>boolean</pre> | Returns `true` if the socket is open |
| `host` | <pre>string</pre> | Kuzzle server host |
| `port` | <pre>number</pre> | Kuzzle server port |
| `reconnectionDelay` | <pre>number</pre> | Number of milliseconds between reconnection attempts |
| `ssl` | <pre>boolean</pre> | `true` if ssl is active |

::: info
Updates to `autoReconnect` and `reconnectionDelay` properties will only take effect on the next `connect` call.
:::
:::
4 changes: 4 additions & 0 deletions src/sdk/js/6/protocols/websocket/properties/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ order: 10
| Property name | Type | Description |
| -------------------- | -------- | ---------------------|
| `autoReconnect` | <pre>boolean</pre> | Automatically reconnect after a connection loss |
| `connected` | <pre>boolean</pre> | Returns `true` if the socket is open |
| `host` | <pre>string</pre> | Kuzzle server host |
| `reconnectionDelay` | <pre>number</pre> | Number of milliseconds between reconnection attempts |
| `port` | <pre>number</pre> | Kuzzle server port |
| `ssl` | <pre>boolean</pre> | `true` if ssl is active |

::: info
Updates to `autoReconnect` and `reconnectionDelay` properties will only take effect on the next `connect` call.
Expand Down