You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-12Lines changed: 4 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,9 +24,8 @@ This is the official Javascript SDK for the free and open-source backend Kuzzle.
24
24
25
25
#### Multiprotocols
26
26
27
-
Currently, the SDK provides 3 protocols: __Http, WebSocket and SocketIO.__
28
-
WebSocket and Socket.IO protocols implement the whole Kuzzle API, while the HTTP protocol does not implement realtime features (rooms and subscriptions).
29
-
While Socket.IO offers better compatibility with older web browsers, our raw WebSocket implementation is about 20% faster.
27
+
Currently, the SDK provides 2 protocols: __Http and WebSocket.__
28
+
WebSocket protocol implement the whole Kuzzle API, while the HTTP protocol does not implement realtime features (rooms and subscriptions).
30
29
31
30
#### Promises based
32
31
@@ -35,7 +34,7 @@ For example, for the action create of the controller collection (_collection:cre
35
34
Any error must be caught either at the end of the `Promise` chain, or by using `async/await` and a `try...catch`.
@@ -113,13 +112,6 @@ Then the Kuzzle SDK will be available under the `KuzzleSDK` variable:
113
112
</script>
114
113
```
115
114
116
-
If you want to support older browser versions, you may load `socket.io` before Kuzzle, making the SDK compatible with browsers without websocket support:
117
-
118
-
```html
119
-
<!-- Don't forget to include socketio before Kuzzle SDK -->
Copy file name to clipboardExpand all lines: doc/7/controllers/auth/login/index.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@ description: Authenticate a user
9
9
10
10
Authenticates a user.
11
11
12
-
If this action is successful, then the [jwt](/sdk/js/6/core-classes/kuzzle/properties) property of this class instance is set to the new authentication token.
12
+
If this action is successful, then the [jwt](/sdk/js/7/core-classes/kuzzle/properties) property of this class instance is set to the new authentication token.
13
13
14
-
All further requests emitted by this SDK instance will be on behalf of the authenticated user, until either the authenticated token expires, the [logout](/sdk/js/6/controllers/auth/logout) action is called, or the `jwt` property is manually set to another value.
14
+
All further requests emitted by this SDK instance will be on behalf of the authenticated user, until either the authenticated token expires, the [logout](/sdk/js/7/controllers/auth/logout) action is called, or the `jwt` property is manually set to another value.
The name of the [authentication strategy](/core/1/guides/kuzzle-depth/authentication) used to log the user in.
32
+
The name of the [authentication strategy](/core/2/guides/kuzzle-depth/authentication) used to log the user in.
33
33
34
34
Depending on the chosen authentication strategy, additional credential arguments may be required.
35
35
The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local).
36
36
37
-
Check the appropriate [authentication plugin](/core/1/plugins/guides/strategies/overview) documentation to get the list of additional arguments to provide.
37
+
Check the appropriate [authentication plugin](/core/2/plugins/guides/strategies/overview) documentation to get the list of additional arguments to provide.
38
38
39
39
### expiresIn
40
40
41
-
The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guides/essentials/configuration).
41
+
The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/essentials/configuration).
Copy file name to clipboardExpand all lines: doc/7/controllers/auth/refresh-token/index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,9 @@ description: Refresh an authentication token
11
11
12
12
Refreshes a valid, non-expired authentication token.
13
13
14
-
If this action is successful, then the [jwt](/sdk/js/6/core-classes/kuzzle/properties) property of this class instance is set to the new authentication token.
14
+
If this action is successful, then the [jwt](/sdk/js/7/core-classes/kuzzle/properties) property of this class instance is set to the new authentication token.
15
15
16
-
All further requests emitted by this SDK instance will be on behalf of the authenticated user, until either the authenticated token expires, the [logout](/sdk/js/6/controllers/auth/logout) action is called, or the `jwt` property is manually set to another value.
16
+
All further requests emitted by this SDK instance will be on behalf of the authenticated user, until either the authenticated token expires, the [logout](/sdk/js/7/controllers/auth/logout) action is called, or the `jwt` property is manually set to another value.
17
17
18
18
19
19
## Arguments
@@ -40,15 +40,15 @@ Additional query options
40
40
41
41
### expiresIn
42
42
43
-
The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/1/guides/essentials/configuration).
43
+
The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/essentials/configuration).
44
44
45
45
## Resolves
46
46
47
47
The `refreshToken` action resolves to a token object with the following properties:
48
48
49
49
| Property | Type | Description |
50
50
|--------------|---------|-------------|
51
-
|`_id`| <pre>string</pre> | User unique identifier ([kuid](/core/1/guides/essentials/user-authentication#kuzzle-user-identifier-kuid)) |
51
+
|`_id`| <pre>string</pre> | User unique identifier ([kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid)) |
52
52
|`expiresAt`| <pre>number</pre> | Expiration timestamp in Epoch-millis format (UTC) |
Copy file name to clipboardExpand all lines: doc/7/controllers/auth/update-self/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ description: Updates the current user object in Kuzzle.
9
9
10
10
Updates the currently logged in user content.
11
11
12
-
This route cannot update the list of associated security profiles. To change a user's security profiles, the route [security:updateUser](/core/1/api/controllers/security/update-user) must be used instead.
12
+
This route cannot update the list of associated security profiles. To change a user's security profiles, the route [security:updateUser](/core/2/api/controllers/security/update-user) must be used instead.
13
13
14
14
<br/>
15
15
@@ -34,7 +34,7 @@ Additional query options
34
34
35
35
## Resolves
36
36
37
-
A [User](/sdk/js/6/core-classes/user) representing the current user logged with the SDK.
37
+
A [User](/sdk/js/7/core-classes/user) representing the current user logged with the SDK.
Copy file name to clipboardExpand all lines: doc/7/controllers/bulk/import/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ description: Performs a bulk import on a collection
9
9
10
10
Create, update or delete large amount of documents as fast as possible.
11
11
12
-
This route is faster than the `document:m*` routes family (e.g. [document:mCreate](/sdk/js/6/controllers/document/m-create)), but no real-time notifications will be generated, even if some of the documents in the import match subscription filters.
12
+
This route is faster than the `document:m*` routes family (e.g. [document:mCreate](/sdk/js/7/controllers/document/m-create)), but no real-time notifications will be generated, even if some of the documents in the import match subscription filters.
Copy file name to clipboardExpand all lines: doc/7/controllers/collection/create/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ description: Create a new collection
7
7
8
8
# create
9
9
10
-
Creates a new [collection](/core/1/guides/essentials/store-access-data) in Kuzzle via the persistence engine, in the provided index.
10
+
Creates a new [collection](/core/2/guides/essentials/store-access-data) in Kuzzle via the persistence engine, in the provided index.
11
11
12
12
You can also provide an optional data mapping that allow you to exploit the full capabilities of our
13
13
persistent data storage layer, [ElasticSearch](https://www.elastic.co/products/elasticsearch) (check here the [mapping capabilities of ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/mapping.html)).
@@ -48,7 +48,7 @@ const mapping = {
48
48
};
49
49
```
50
50
51
-
More informations about database mappings [here](/core/1/guides/essentials/database-mappings).
51
+
More informations about database mappings [here](/core/2/guides/essentials/database-mappings).
0 commit comments