Commit 95ad1eaa authored by Panagiotis Skarvelis's avatar Panagiotis Skarvelis
Browse files

add js docs

parent 5f7b2018
......@@ -29,13 +29,29 @@ export type errorRecord = {
errorDescr:string;
}
/**
* @type Overrides
* @description Overrides for the SOAP client
* @param {boolean} prod - Set to true for production environment
* @param {string} auditInit - Audit record initializer to be used for the audit record produced
* @param {string} auditStoragePath - Path to the audit record storage
*/
export type Overides = {
prod?:boolean;
auditInit?: AuditRecord;
auditStoragePath?: string;
}
import config from './config.json';
/**
*
* @param afm string;
* @param user string;
* @param pass string;
* @param overides Overides;
* @returns AuditRecord | errorRecord
*/
export const getIdentity = async (afm:string, user:string, pass:string, overides?:Overides) => {
const prod = overides?.prod ?? false;
const auditInit = overides?.auditInit ?? {} as AuditRecord;
......
import soap from 'soap';
import {AuditRecord} from '@digigov-oss/gsis-audit-record-db';
/**
* SOAP client for getNncIdentity
* @class Soap
* @description SOAP client for getNncIdentity
* @param {string} wsdl - The URL of the SOAP service
* @param {string} username
* @param {string} password
* @param {AuditRecord} auditRecord
*/
class Soap {
private _client: any;
private _wsdl: string;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment