1.0.4 • Published 2 years ago
icp-pkg-cognito-validation v1.0.4
icp-pkg-cognito-validation
Table of Contents
Overview (or Why)
This library allows us to correctly validate Cognito sessions
Quick start
Install
Typically, these types of packages are scoped packages and are private by default.
If this is the case, this is an example of the .npmrc
file,
which should be at the root of the project where this package will be used.
//registry.npmjs.org/:_authToken=PUT-THE-AUTHENTICATION-TOKEN-HERE
Note: The authentication token should be requested from the infrastructure team.
Using npm:
npm install @zxventures/icp-pkg-cognito-validation
Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples included in this README file or other sources.
// This is an example of how to use the operations package (sum and multiply).
const { sum, multiply } = require('@scope-name/operations');
const sumResult = sum(10, 20, 5, 15);
console.log('sumResult: ', sumResult);
const multiplyResult = multiply(10, 20, 5, 15);
console.log('multiplyResult: ', multiplyResult);
// output:
// sumResult: 50
// multiplyResult: 15000
How To Run Locally
Prerequisites
- NodeJs 14
- << Include extras >>
Installation
Install dependencies
npm i
Run Locally
Provide instructions and examples so users/devs can run this repo locally.
// Use examples liberally
Run unit test and code coverage
Run
npm test
To run code coverage use
npm run coverage