Merge pull request #64 from JJ-Cro/EndpointMap

feat(): Added endpoint function map
tiagosiebler · Aug 30, 2024 · 9f6be5c · 9f6be5c
2 parents 0cb61ab + 7ca5cf1
commit 9f6be5c
Show file tree

Hide file tree

Showing 3 changed files with 384 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -24,3 +24,4 @@ bundleReport.html
 .history/
 .idea
 privaterepotracker
+restClientRegex.ts
diff --git a/README.md b/README.md
@@ -56,8 +56,9 @@ Check out my related JavaScript/TypeScript/Node.js projects:
 
 Most methods accept JS objects. These can be populated using parameters specified by okx's API documentation, or check the type definition in the rest-client class methods.
 
-- [RestClient](src/rest-client.ts).
-- [OKX API Documentation](https://www.okx.com/docs-v5/en/#rest-api).
+- [RestClient](src/rest-client.ts)
+- [OKX API Documentation](https://www.okx.com/docs-v5/en/#rest-api)
+- [REST Endpoint Function List](./docs/endpointFunctionList.md)
 - [TSDoc Documentation (generated using typedoc via npm module)](https://tsdocs.dev/docs/okx-api)
 
 ## Contributions & Thanks