Skip to content

Commit ae93a33

Browse files
committed
Update documentation
1 parent c775313 commit ae93a33

File tree

2 files changed

+58
-5
lines changed

2 files changed

+58
-5
lines changed

docs/content/release_notes.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,38 @@
11
# Release Notes
22

3+
## 6.3.0
4+
**New Features**
5+
6+
* Added support for authentication using [JWT](https://en.wikipedia.org/wiki/JSON_Web_Token). This feature is intentionally undocumented.
7+
8+
## 6.2.6
9+
**Technical Enhancements**
10+
11+
* Updated the [`uuid`](https://github.com/uuidjs/uuid) library to the next major version.
12+
13+
## 6.2.5
14+
**Bug Fixes**
15+
16+
* Updated `SymbolParser.getProducerSymbol` function, addressing failure to properly translate symbols for futures which expire in 10 or more years (e.g. `CLG34` now correctly translates to `GLB4`).
17+
18+
**Technical Enhancements**
19+
20+
* Updated AWS CodeBuild to use Node.js version 20.
21+
22+
## 6.2.4
23+
**Other**
24+
25+
* Removed logging of message objects which cannot be processed.
26+
27+
## 6.2.3
28+
**Bug Fixes**
29+
30+
* Corrected failure of `2/0/D` and `2/0/d` messages to assign `Quote.settlementPrice` property value.
31+
332
## 6.2.2
433
**Other**
534

6-
* Update README.md to indicate this library will be deprecated in the near future.
35+
* Updated README.md file indicating this library will be deprecated in the near future.
736

837
## 6.2.1
938
**Bug Fixes**

docs/content/sdk/lib-connection.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
* [Connection](#Connection) ⇐ <code>ConnectionBase</code>
2626
* _instance_
27-
* [.connect(hostname, username, password, [webSocketAdapterFactory], [xmlParserFactory])](#Connectionconnect)
27+
* [.connect(hostname, [username], [password], [webSocketAdapterFactory], [xmlParserFactory], [jwtProvider])](#Connectionconnect)
2828
* [.disconnect()](#Connectiondisconnect)
2929
* [.on(subscriptionType, callback, [symbol])](#Connectionon)
3030
* [.off(subscriptionType, callback, [symbol])](#Connectionoff)
@@ -41,13 +41,14 @@
4141
* [.getServer()](#ConnectiongetServer) ⇒ <code>null</code> \| <code>string</code>
4242
* [.getPassword()](#ConnectiongetPassword) ⇒ <code>null</code> \| <code>string</code>
4343
* [.getUsername()](#ConnectiongetUsername) ⇒ <code>null</code> \| <code>string</code>
44+
* [.getJwtProvider()](#ConnectiongetJwtProvider) ⇒ <code>null</code> \| [<code>JwtProvider</code>](#CallbacksJwtProvider)
4445
* _constructor_
4546
* [new Connection([environment])](#new_Connection_new)
4647

4748

4849
* * *
4950

50-
### connection.connect(hostname, username, password, [webSocketAdapterFactory], [xmlParserFactory]) :id=connectionconnect
51+
### connection.connect(hostname, [username], [password], [webSocketAdapterFactory], [xmlParserFactory], [jwtProvider]) :id=connectionconnect
5152
> Establishes WebSocket connection to Barchart's servers and authenticates. Success
5253
> or failure is reported asynchronously by the <strong>Events</strong> subscription (see
5354
> [SubscriptionType](#enumssubscriptiontype)). Connection attempts will continue until
@@ -60,10 +61,11 @@
6061
| Param | Type | Description |
6162
| --- | --- | --- |
6263
| hostname | <code>string</code> | <p>Barchart hostname (contact [email protected])</p> |
63-
| username | <code>string</code> | <p>Your username (contact [email protected])</p> |
64-
| password | <code>string</code> | <p>Your password (contact [email protected])</p> |
64+
| [username] | <code>string</code> | <p>Your username (contact [email protected])</p> |
65+
| [password] | <code>string</code> | <p>Your password (contact [email protected])</p> |
6566
| [webSocketAdapterFactory] | [<code>WebSocketAdapterFactory</code>](/content/sdk/lib-connection-adapter?id=websocketadapterfactory) | <p>Strategy for creating a [WebSocketAdapterFactory](/content/sdk/lib-connection-adapter?id=websocketadapterfactory) instances (overrides [Environment](/content/sdk/lib-environment?id=environment) settings).</p> |
6667
| [xmlParserFactory] | [<code>XmlParserFactory</code>](/content/sdk/lib-utilities-xml?id=xmlparserfactory) | <p>Strategy for creating a [WebSocketAdapterFactory](/content/sdk/lib-connection-adapter?id=websocketadapterfactory) instances (overrides [Environment](/content/sdk/lib-environment?id=environment) settings).</p> |
68+
| [jwtProvider] | [<code>JwtProvider</code>](#CallbacksJwtProvider) | <p>A function which returns a JWT (or a promise for a JWT) that is used as an alternative for actual credentials.</p> |
6769

6870

6971
* * *
@@ -268,6 +270,16 @@
268270

269271
* * *
270272

273+
### connection.getJwtProvider() :id=connectiongetjwtprovider
274+
> The username used to authenticate to Barchart.
275+
276+
**Kind**: instance method of [<code>Connection</code>](#Connection)
277+
**Overrides**: [<code>getJwtProvider</code>](#ConnectionBasegetJwtProvider)
278+
**Returns**: <code>null</code> \| [<code>JwtProvider</code>](#CallbacksJwtProvider)
279+
**Access**: public
280+
281+
* * *
282+
271283
### new Connection([environment]) :id=new_connection_new
272284
**Kind**: constructor of [<code>Connection</code>](#Connection)
273285

@@ -341,13 +353,25 @@
341353

342354
* [Callbacks](#Callbacks) : <code>object</code>
343355
* _static_
356+
* [.JwtProvider](#CallbacksJwtProvider) ⇒ <code>string</code> \| <code>Promise.&lt;string&gt;</code>
344357
* [.EventsCallback](#CallbacksEventsCallback) : <code>function</code>
345358
* [.TimestampCallback](#CallbacksTimestampCallback) : <code>function</code>
346359
* [.MarketUpdateCallback](#CallbacksMarketUpdateCallback) : <code>function</code>
347360
* [.MarketDepthCallback](#CallbacksMarketDepthCallback) : <code>function</code>
348361
* [.CumulativeVolumeCallback](#CallbacksCumulativeVolumeCallback) : <code>function</code>
349362

350363

364+
* * *
365+
366+
### Callbacks.JwtProvider :id=callbacksjwtprovider
367+
> The signature of a function which returns a JWT. The JWT is
368+
> then used as an alternative for credentials (i.e. a username
369+
> and password). The function can be synchronous or asynchronous.
370+
371+
**Kind**: static typedef of [<code>Callbacks</code>](#Callbacks)
372+
**Returns**: <code>string</code> \| <code>Promise.&lt;string&gt;</code>
373+
**Access**: public
374+
351375
* * *
352376

353377
### Callbacks.EventsCallback :id=callbackseventscallback

0 commit comments

Comments
 (0)