coinranking-oss-sdk - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "coinranking-oss-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "An unofficial SDK for the coinranking REST API.",
@@ -5,0 +5,0 @@ "main": "src/coinranking-oss-sdk-index.js",

readme.md

@@ -8,2 +8,4 @@
 
+**Note**: *For now, documentation will be incomplete. Methods will be listed and briefly explained, but thorough descriptions will be filled in later.*
+
 # How to use these docs
@@ -36,15 +38,4 @@
 - Takes:
-    - config: Object | optional config object
+    - config: Object | optional config object (Described below this entry)
 
-- config properties:
-    - **apiKey**: String | your api auth key from
-        https://coinranking.com/page/key-generator
-
-    - **shouldCache**: Boolean | False by default. if true, the sdk will store any data
-        retreived from the api with get requests. This data will be returned by subsequent calls of any functions that need to retrieve data. Purpose is to save on api requests, in order to stay under rate limits. See more about rate limiting: https://developers.coinranking.com/api/documentation/#rate-limits
-    
-    - **cacheRefreshInterval**: Number | Amount of time in milliseconds the sdk will wait
-        before retrieving new data from the API upon a new get method being called.
-        Not used if shouldCache is false.
-
 - Returns: Void | Nothing is returned.
@@ -57,5 +48,93 @@
     apiKey: '5030820852jds',
-    shouldCache: false,
-    cacheRefreshInterval: 0, // milliseconds
+    limit: 50,
+    showDeepResults: true,
 })
 ```
+
+#### config: Object
+
+**High Level**: An optional object to be passed to the init() method. The config object sets the default options for queries. In future versions of the SDK, you will be able to modify the config after init is called. For now, you can pass your optional parameters into the queryParameters objects of the methods you call, as will be explained later in the documentation. Below is the list of functioning config properties:
+
+- config properties:
+    - **apiKey**: String | your api auth key from
+        https://coinranking.com/page/key-generator
+
+    - **showDeepResults**: Boolean | tells the sdk whether you want results of your queries to have all possible details or not. Default false.
+
+### *async* getCoins(queryParams | Object, optional)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return a list of all existing coins in the coinranking API.
+
+### *async* getExchanges(queryParams | Object, optional)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return a list of all existing exchanges in the coinranking API.
+
+### *async* getMarkets(queryParams | Object, optional)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return a list of all existing markets in the coinranking API.
+
+### *async* getDapps(queryParams | Object, optional)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return a list of all existing dapps in the coinranking API.
+
+### *async* getNFTs(queryParams | Object, optional)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return a list of all existing NFTs in the coinranking API.
+
+### *async* getCoinByQuery(query | required String, options | optional Object)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Find a coin or set of coins that match your query string.
+
+### *async* getExchangesByQuery(query | required String, options | optional Object)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Find an exchange or set of exchanges that match your query string.
+
+### *async* getMarketByQuery(query | required String, options | optional Object)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Find a market or set of markets that match your query string.
+
+### *async* getAllByQuery(query | required String, options | optional Object)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return all items of all data types which match your query string.
+
+### *async* getCoinByUuid(uuid | required String, queryParams | Object, optional)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return a coin that matches the provided uuid.
+
+### *async* getExchangeByUuid(uuid | required String, queryParams | Object, optional)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return an exchange that matches the provided uuid.
+
+### *async* getDapp(dappName | required String, queryParams | Object, optional)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return a Dapp that matches the provided name.
+
+### *async* getNFT(id | required String, queryParams | Object, optional)
+
+*For a list of all params, check out the API documentation: https://developers.coinranking.com/api/documentation*
+
+**High Level**: Return an NFT that matches the provided id.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19073

increased by23.19%

Number of lines in readme file

138

increased by133.9%

No dependency changes