version

Author: thomasplevy

index.js

@@ -1,3 +1,10 @@
+/**
+ * Main API class
+ *
+ * @since 1.0.0
+ * @version 1.0.0
+ */
+
 'use strict';
 
 const
@@ -8,7 +15,7 @@ const
 /**
  * LifterLMS REST API Wrapper
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param obj options {
  *    An object of configuration options
@@ -57,7 +64,7 @@ function API( options ) {
 /**
  * Registers all LifterLMS core Request methods with the main api instance so they can be accessed without the vendor prefix.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @return void
  */
@@ -77,7 +84,7 @@ API.prototype._unprefixCore = function() {
 /**
  * Set options.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param obj options object. See definition for `api()` for more details.
  * @return void
@@ -103,7 +110,7 @@ API.prototype._setOptions = function( options ) {
 /**
  * Retrieve a class option.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param string key Option name.
  * @return mixed
@@ -115,7 +122,7 @@ API.prototype.getOption = function( key ) {
 /**
  * Register a custom namespace that can be utilized for accessing WP Rest API endpoints for 3rd party vendors.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @see {Reference}
  * @link {URL}

lib/API.js

@@ -1,3 +1,10 @@
+/**
+ * Main Request class
+ *
+ * @since 1.0.0
+ * @version 1.0.0
+ */
+
 'use strict';
 
 const
@@ -11,7 +18,7 @@ const
 /**
  * Constructor
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param API api API Instance.
  * @param string namespace Vendor string (eg "llms/v1").
@@ -26,7 +33,7 @@ function Request( api, namespace ) {
 /**
  * Build a full URL for a request.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param string Endpoint path.
  * @return string
@@ -58,7 +65,7 @@ Request.prototype._getURL = function( endpoint ) {
 /**
  * Build arguments to pass with a request
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param string method HTTP method.
  * @param string endpoint Request endpoint.
@@ -103,7 +110,7 @@ Request.prototype._getRequestArgs = function( method, endpoint, data ) {
 /**
  * Preform requests.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @see {Reference}
  * @link {URL}
@@ -136,7 +143,7 @@ Request.prototype._request = function( method, endpoint, data_or_callback, callb
 /**
  * Preform a GET request.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param string endpoint Request endpoint.
  * @param obj|function|null data_or_callback Data (to be converted to query string parameters) or callback function.
@@ -150,7 +157,7 @@ Request.prototype.get = function( endpoint, data_or_callback, callback ) {
 /**
  * Preform a POST request.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param string endpoint Request endpoint.
  * @param obj|function|null data Request data.
@@ -164,7 +171,7 @@ Request.prototype.post = function( endpoint, data, callback ) {
 /**
  * Preform a PUT request.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param string endpoint Request endpoint.
  * @param obj|function|null data Request data.
@@ -178,7 +185,7 @@ Request.prototype.put = function( endpoint, data, callback ) {
 /**
  * Preform a Delete request.
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param string endpoint Request endpoint.
  * @param obj|function|null data_or_callback Request data or callback function.
@@ -192,7 +199,7 @@ Request.prototype.delete = function( endpoint, data_or_callback, callback ) {
 /**
  * Preform an options request.
  *
- * @since [version]
+ * @since 1.0.0
  *
 * @param string endpoint Request endpoint.
 * @param Function callback Callback function.

lib/Request.js

@@ -1,3 +1,10 @@
+/**
+ * Utility functiosn
+ *
+ * @since 1.0.0
+ * @version 1.0.0
+ */
+
 'use strict';
 
 /**

lib/utils.js

@@ -0,0 +1,10 @@
+/**
+ * LifterLMS API
+ *
+ * @since 1.0.0
+ * @version [version]
+ */
+
+'use strict';
+
+module.exports = require( './lib/API' );

lifterlms-api.js

@@ -1,6 +1,6 @@
 {
   "name": "llms-api-node",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Node.js wrapper for the LifterLMS REST API",
   "main": "index.js",
   "scripts": {

package.json

@@ -1,3 +1,10 @@
+/**
+ * Test Helpers
+ *
+ * @since 1.0.0
+ * @version 1.0.0
+ */
+
 'use strict';
 
 const
@@ -6,7 +13,7 @@ const
 /**
  * Retrieve instance of LifterLMS API
  *
- * @since [version]
+ * @since 1.0.0
  *
  * @param object options options to assign to the API instance.
  * @param bool merge if true, merges options with default mock options.

tests/helpers.js

@@ -1,3 +1,10 @@
+/**
+ * Test API Class
+ *
+ * @since 1.0.0
+ * @version 1.0.0
+ */
+
 'use strict';
 
 const

tests/test-API.js

@@ -1,3 +1,10 @@
+/**
+ * Test Request Class
+ *
+ * @since 1.0.0
+ * @version 1.0.0
+ */
+
 'use strict';
 
 const

tests/test-Request.js

@@ -1,3 +1,10 @@
+/**
+ * Test Utility Functions
+ *
+ * @since 1.0.0
+ * @version 1.0.0
+ */
+
 'use strict';
 
 const