docs: updating docs

* Enumeration's done
* general lint formatting issues

#13

[ci skip]

src/client/hl7Outbound.ts

@@ -3,14 +3,18 @@ import net, { Socket } from 'node:net'
 import tls from 'node:tls'
 import { Batch } from '../builder/batch.js'
 import { Message } from '../builder/message.js'
-import {CR, FS, VT} from "../utils/constants";
+import { CR, FS, VT } from '../utils/constants.js'
 import { ReadyState } from '../utils/enum.js'
 import { HL7FatalError } from '../utils/exception.js'
 import { ClientListenerOptions, normalizeClientListenerOptions } from '../utils/normalizedClient.js'
 import { expBackoff, randomString } from '../utils/utils.js'
 import { Client } from './client.js'
-import {InboundResponse} from "./module/inboundResponse";
+import { InboundResponse } from './module/inboundResponse.js'
 
+/**
+ * Outbound Handler
+ * @since 1.0.0
+ */
 export type OutboundHandler = (res: InboundResponse) => Promise<void>
 
 /** HL7 Outbound Class

src/client/module/inboundResponse.ts

@@ -1,5 +1,4 @@
-import {Message} from "../../builder/message.js";
-
+import { Message } from '../../builder/message.js'
 
 /**
  * Inbound Request
@@ -16,7 +15,7 @@ export class InboundResponse {
    * @param data
    */
   constructor (data: string) {
-    this._message = new Message({text: data.toString()})
+    this._message = new Message({ text: data.toString() })
   }
 
   /** '
@@ -27,5 +26,4 @@ export class InboundResponse {
   getMessage (): Message {
     return this._message
   }
-
 }

src/index.ts

@@ -1,5 +1,7 @@
 import { NodeBase } from './builder/modules/nodeBase.js'
 import { EmptyNode } from './builder/modules/emptyNode.js'
+import { ValueNode } from './builder/modules/valueNode.js'
+import { RootBase } from './builder/modules/rootBase.js'
 import { Node } from './builder/interface/node.js'
 import { Client } from './client/client.js'
 import { Component } from './builder/modules/component.js'
@@ -52,4 +54,4 @@ export type { ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuild
 export type { HL7Error, HL7FatalError, HL7ParserError } from './utils/exception.js'
 
 export default Client
-export { Client, HL7Outbound, OutboundHandler, FileBatch, Batch, Message, Segment, SegmentList, Component, SubComponent, Field, FieldRepetition, ParserPlan, Node, NodeBase, EmptyNode, Delimiters, ReadyState }
+export { Client, HL7Outbound, OutboundHandler, FileBatch, Batch, Message, Segment, SegmentList, Component, SubComponent, Field, FieldRepetition, ParserPlan, Node, RootBase, NodeBase, ValueNode, EmptyNode, Delimiters, ReadyState }

src/specification/2.7.1.ts

@@ -1,5 +1,4 @@
 import { Message } from '../builder/message.js'
-import { randomString } from '../utils/utils.js'
 import { HL7_2_7 } from './2.7.js'
 
 /**

src/specification/2.7.ts

@@ -1,5 +1,4 @@
 import { Message } from '../builder/message.js'
-import { randomString } from '../utils/utils.js'
 import { HL7_2_6 } from './2.6.js'
 
 /**

src/specification/2.8.ts

@@ -1,5 +1,4 @@
 import { Message } from '../builder/message.js'
-import { randomString } from '../utils/utils.js'
 import { HL7_2_7_1 } from './2.7.1.js'
 
 /**

src/utils/constants.ts

@@ -1,8 +1,8 @@
 /** @internal */
-export const VT = String.fromCharCode(0x0b);
+export const VT = String.fromCharCode(0x0b)
 
 /** @internal */
-export const FS = String.fromCharCode(0x1c);
+export const FS = String.fromCharCode(0x1c)
 
 /** @internal */
-export const CR = String.fromCharCode(0x0d);
+export const CR = String.fromCharCode(0x0d)

src/utils/enum.ts

@@ -1,25 +1,38 @@
 /**
  * Type of Segments Values
  * @description Used during the class creation to give each type its own index value.
+ * This is done during the constructor phase of the classes.
  * @since 1.0.0
  */
 export enum Delimiters {
+  /** Usually each line of the overall HL7 Message. */
   Segment,
+  /** The field of each segment. Usually separated with a | */
   Field,
+  /** Usually within each Field, seperated by ^ */
   Component,
+  /** Usually within each Component, seperated by & */
   Repetition,
+  /** The escape string used within the code. */
   Escape,
+  /** Usually within each Field, seperated by ~ */
   SubComponent
 }
 
 /**
  * State of the Connected to the Server
+ * @description These are the states that are used to track the connecting to the server side and also during the auto-reconnect phase.
  * @since 1.0.0
  */
 export enum ReadyState {
+  /** The client is trying to connect to the server. */
   CONNECTING,
+  /** The client is connected to the server.  */
   CONNECTED,
+  /** The client is open, but not yet trying to connect to the server.  */
   OPEN,
+  /** The client is closing the connection by force or by timeout */
   CLOSING,
+  /** The client connection is closed.  */
   CLOSED
 }