@dxfeed/dxlink-api - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

README.md

+# @dxfeed/dxlink-api
+
+This package provides access to market data from [dxFeed](https://www.dxfeed.com/) services via dxLink API.
+
+## Install
+
+```bash
+npm install @dxfeed/dxlink-api
+```
+
+## Usage
+
+Import client and feed into your project.
+
+```typescript
+import { DXLinkWebSocket, DXLinkFeed } from '@dxfeed/dxlink-api'
+```
+
+### Client
+
+Create instance of the client.
+
+```typescript
+const client = new DXLinkWebSocketClient()
+```
+
+Connect to the server.
+
+```typescript
+client.connect('wss://demo.dxfeed.com/dxlink-ws')
+```
+
+Provide auth token if required by the server.
+
+```typescript
+client.setAuthToken(token)
+```
+
+### Feed
+
+Create Feed with delivery contract `AUTO`.
+
+```typescript
+const feed = new DXLinkFeed(client, 'AUTO')
+```
+
+Configure created feed.
+
+```typescript
+feed.configure({
+  acceptAggregationPeriod: 10,
+  acceptDataFormat: FeedDataFormat.COMPACT,
+  acceptEventFields: {
+    Quote: ['eventSymbol', 'askPrice', 'bidPrice'],
+    Candle: ['eventSymbol', 'open', 'close', 'high', 'low', 'volume'],
+  },
+})
+```
+
+Add subscription to the feed.
+
+```typescript
+const sub1 = {
+  type: 'Quote',
+  symbol: 'AAPL',
+}
+
+channel.addSubscriptions(sub1)
+```
+
+Remove subscription from the feed.
+
+```typescript
+channel.removeSubscriptions(sub1)
+```
+
+Receive data from the channel.
+
+```typescript
+feed.addEventListener(events) => {
+  // do something with events
+})
+```

package.json

 {
   "name": "@dxfeed/dxlink-api",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": false,
@@ -29,5 +29,5 @@ "sideEffects": false,
   "dependencies": {
-    "@dxfeed/dxlink-core": "0.1.0",
-    "@dxfeed/dxlink-websocket-client": "0.1.0",
-    "@dxfeed/dxlink-feed": "0.1.0"
+    "@dxfeed/dxlink-core": "0.1.1",
+    "@dxfeed/dxlink-websocket-client": "0.1.1",
+    "@dxfeed/dxlink-feed": "0.1.1"
   },
@@ -34,0 +34,0 @@ "author": "Dmitry Petrov <[e-mail]>",

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6067

29%

Number of package files

11

10%

Number of medium quality alerts

0

-100%

Number of lines in readme file

84

Infinity%

Dependency changes

• + Added

  @dxfeed/dxlink-core@0.1.1
  (transitive)

• + Added

  @dxfeed/dxlink-feed@0.1.1
  (transitive)

• + Added

  @dxfeed/dxlink-websocket-client@0.1.1
  (transitive)

• - Removed

  @dxfeed/dxlink-core@0.1.0
  (transitive)

• - Removed

  @dxfeed/dxlink-feed@0.1.0
  (transitive)

• - Removed

  @dxfeed/dxlink-websocket-client@0.1.0
  (transitive)

• Updated

  @dxfeed/dxlink-core@0.1.1

• Updated

  @dxfeed/dxlink-feed@0.1.1

• Updated

  @dxfeed/dxlink-websocket-client@0.1.1