/docs added, generated by documentation.js

Author: gitcommitshow

README.md

@@ -11,6 +11,9 @@ A demo to learn JWT by reverse engineering
 
 ![Demo GIF](./demo.gif)
 
+## Documentation
+
+If you want to extend code for more functionalities, [checkout the documentation](./docs.md)
 
 ## References
 

docs.md

@@ -0,0 +1,194 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [isAuthenticated][1]
+    -   [Parameters][2]
+    -   [Examples][3]
+-   [TokenExchange][4]
+    -   [Properties][5]
+    -   [Examples][6]
+-   [ReadFromUrlParam][7]
+    -   [Examples][8]
+-   [ReadFromBody][9]
+    -   [Examples][10]
+-   [ReadFromCookies][11]
+    -   [Examples][12]
+-   [ReadFromHeader][13]
+    -   [Parameters][14]
+    -   [Examples][15]
+-   [ReadFromHeaderWithBearerScheme][16]
+    -   [Parameters][17]
+    -   [Examples][18]
+-   [setDefaultStrategy][19]
+    -   [Parameters][20]
+
+## isAuthenticated
+
+Express middleware for authentication using JWT paradigm
+
+### Parameters
+
+-   `req`  
+-   `res`  
+-   `next`  
+
+### Examples
+
+```javascript
+app.get('protectedEndpoint', [isAuthenticated], function(req, res){})
+```
+
+## TokenExchange
+
+Abstract implementation of strategy to read/manipulate token in request
+
+### Properties
+
+-   `read` **[Function][21]** (req) - Function that extracts token from request object
+-   `setTokenReadStrategy` **[Function][21]** (strategyInstance) - Set strategy for reading token
+
+### Examples
+
+```javascript
+let tokenExchange = new TokenExchange()
+// Define your own strategy(a function) to read token, let's call it MyTokenReadStrategy
+tokenExchange.setTokenReadStrategy(new MyTokenReadStrategy())
+tokenExchange.read(req);
+returns token
+```
+
+## ReadFromUrlParam
+
+-   **See: [TokenExchange][4]
+    **
+
+A strategy to read token from request query parameters. Sent via
+Can be implemted via TokenExchange
+
+### Examples
+
+```javascript
+new TokenExchange().setTokenReadStrategy(new ReadFromBody())
+// When token was sent /apiEndpoint?access_token=String
+```
+
+## ReadFromBody
+
+-   **See: [TokenExchange][4]
+    **
+
+A strategy to read token from request body
+Can be implemted via TokenExchange
+
+### Examples
+
+```javascript
+new TokenExchange().setTokenReadStrategy(new ReadFromBody())
+// When token was sent ia `POST /apiEndpoint -d '{access_token: String}'`
+```
+
+## ReadFromCookies
+
+-   **See: [TokenExchange][4]
+    **
+
+A strategy to read token from request cookies
+Can be implemted via TokenExchange
+
+### Examples
+
+```javascript
+new TokenExchange().setTokenReadStrategy(new ReadFromCookies())
+```
+
+## ReadFromHeader
+
+-   **See: [TokenExchange][4]
+    **
+
+A strategy to read token from request header named `authorization`
+Can be implemted via TokenExchange
+
+### Parameters
+
+-   `req`  
+
+### Examples
+
+```javascript
+new TokenExchange().setTokenReadStrategy(new ReadFromHeader())
+```
+
+## ReadFromHeaderWithBearerScheme
+
+-   **See: [TokenExchange][4]
+    **
+
+A strategy to read token from **header with bearer scheme**.
+Can be implemted via TokenExchange
+
+### Parameters
+
+-   `req` **any** : Express Request object
+
+### Examples
+
+```javascript
+new TokenExchange().setTokenReadStrategy(new ReadFromHeaderWithBearerScheme())
+```
+
+## setDefaultStrategy
+
+-   **See: [TokenExchange][4]
+    **
+
+Default strategy when authorization header is available in request : ReadFromHeaderWithBearerScheme
+Default strategy when cookies have `access_token` : ReadFromCookie
+
+### Parameters
+
+-   `req` **any** 
+-   `tokenExchange` **any** 
+
+[1]: #isauthenticated
+
+[2]: #parameters
+
+[3]: #examples
+
+[4]: #tokenexchange
+
+[5]: #properties
+
+[6]: #examples-1
+
+[7]: #readfromurlparam
+
+[8]: #examples-2
+
+[9]: #readfrombody
+
+[10]: #examples-3
+
+[11]: #readfromcookies
+
+[12]: #examples-4
+
+[13]: #readfromheader
+
+[14]: #parameters-1
+
+[15]: #examples-5
+
+[16]: #readfromheaderwithbearerscheme
+
+[17]: #parameters-2
+
+[18]: #examples-6
+
+[19]: #setdefaultstrategy
+
+[20]: #parameters-3
+
+[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function