chore(): cleaning on examples

tiagosiebler · Jun 12, 2024 · 63386c6 · 63386c6
1 parent ad1fb3c
commit 63386c6
Show file tree

Hide file tree

Showing 19 changed files with 40 additions and 63 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -1,6 +1,13 @@
 # Examples
 
-These samples can be executed using `ts-node`:
+These samples can be executed using `ts-node` or `tsx`:
+
+```
+ts-node ./examples/ws-public.ts
+```
+
+Most examples also have minimal typescript, so if you rename them to "js" they should execute fine with just node. TypeScript is recommended but completely optional:
+
 ```
-ts-node ./examples/rest-spot-public.ts
+node ./examples/spot/getTickers.js
 ```
diff --git a/examples/futures/getBalances.ts b/examples/futures/getBalances.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src';
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/futures/getOrders.ts b/examples/futures/getOrders.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src';
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/futures/getTickers.ts b/examples/futures/getTickers.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src'; // Import the RestClient from the src directory
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/futures/submitLimitOrder.ts b/examples/futures/submitLimitOrder.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src'; // Import the RestClient from the src directory
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/futures/submitMarketOrder.ts b/examples/futures/submitMarketOrder.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src'; // Import the RestClient from the src directory
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/rest-private.ts b/examples/rest-private.ts
diff --git a/examples/spot/getBalances.ts b/examples/spot/getBalances.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src'; // Import the RestClient from the src directory
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/spot/getOrders.ts b/examples/spot/getOrders.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src'; // Import the RestClient from the src directory
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/spot/getTickers.ts b/examples/spot/getTickers.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src'; // Import the RestClient from the src directory
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/spot/submitLimitOrder.ts b/examples/spot/submitLimitOrder.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src'; // Import the RestClient from the src directory
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/spot/submitMarketOrder.ts b/examples/spot/submitMarketOrder.ts
@@ -1,4 +1,5 @@
-import { RestClient } from '../../src'; // Import the RestClient from the src directory
+import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
 const account = {

diff --git a/examples/ws-private-perp-futures-wsapi.ts b/examples/ws-private-perp-futures-wsapi.ts
@@ -1,10 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
 import { LogParams, WebsocketClient } from '../src';
-import {
-  WSAPILoginResponse,
-  WSAPIResponse,
-} from '../src/types/websockets/wsAPI';
+// import { LogParams, WebsocketClient } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 const account = {
   key: process.env.API_KEY || 'apiKeyHere',

diff --git a/examples/ws-private-perp-futures.ts b/examples/ws-private-perp-futures.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { LogParams, WebsocketClient } from '../src';
-import { WsTopicRequest } from '../src/lib/websocket/websocket-util';
+import { LogParams, WebsocketClient, WsTopicRequest } from '../src';
+// import { LogParams, WebsocketClient, WsTopicRequest } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 const account = {
   key: process.env.API_KEY || 'apiKeyHere',

diff --git a/examples/ws-private-spot-wsapi.ts b/examples/ws-private-spot-wsapi.ts
@@ -1,10 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
 import { LogParams, WebsocketClient } from '../src';
-import {
-  WSAPILoginResponse,
-  WSAPIResponse,
-} from '../src/types/websockets/wsAPI';
+// import { LogParams, WebsocketClient } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const account = {

diff --git a/examples/ws-private-spot.ts b/examples/ws-private-spot.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { LogParams, WebsocketClient } from '../src';
-import { WsTopicRequest } from '../src/lib/websocket/websocket-util';
+import { LogParams, WebsocketClient, WsTopicRequest } from '../src';
+// import { LogParams, WebsocketClient, WsTopicRequest } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const account = {

diff --git a/examples/ws-public.ts b/examples/ws-public.ts
@@ -1,6 +1,6 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { LogParams, WebsocketClient } from '../src';
-import { WsTopicRequest } from '../src/lib/websocket/websocket-util';
+import { LogParams, WebsocketClient, WsTopicRequest } from '../src';
+// import { LogParams, WebsocketClient, WsTopicRequest } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 // const customLogger = {
 //   // eslint-disable-next-line @typescript-eslint/no-unused-vars

diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,5 @@
 export * from './lib/logger.js';
+export * from './lib/websocket/websocket-util.js';
 export * from './RestClient.js';
 export * from './WebsocketClient.js';
 

diff --git a/tsconfig.linting.json b/tsconfig.linting.json
@@ -4,7 +4,8 @@
     "module": "commonjs",
     "outDir": "dist/cjs",
     "target": "esnext",
-    "rootDir": "../"
+    "rootDir": "../",
+    "allowJs": true
   },
   "include": [
     "src/**/*.*",