fastify-hl7 2.2.0 → 3.1.0

package/README.md

@@ -9,7 +9,7 @@ If you are using this NPM package, please consider giving it a :star: star.
 This will increase its visibility and solicit more contribution from the outside.
 
 This documentation is how to use this plugin, not on how to use the libraries above.
-Head [here](#external-libraries) if you need help with those.
+Head [here](#external-libraries-options) if you need help with those.
 
 ## Table of Contents
 
@@ -19,7 +19,7 @@ Head [here](#external-libraries) if you need help with those.
    2. [Client Quick Start](#client-quick-start)
 3. [Full Documentation](#full-documentation)
    1. [This Library Options](#this-library-options)
-   2. [External Libraries](#external-libraries)
+   2. [External Libraries Options](#external-libraries-options)
 4. [Acknowledgements](#acknowledgements)
 5. [License](#license)
 
@@ -34,48 +34,51 @@ npm install fastify-hl7
 Register this as a plugin.
 
 ```ts
-await fastify.register(fastifyHL7)
+await fastify.register(fastifyHL7);
 ```
 
 ### Server Quick Start
 
 ```ts
 const listener = fastify.hl7.createInbound(
-  'ib_adt',
-  {port: 3001},
+  "ib_adt",
+  { port: 3001 },
   async (req, res) => {
-    const messageReq = req.getMessage()
-    const messageType = req.getType()
+    const messageReq = req.getMessage();
+    const messageType = req.getType();
     // your logic here
-    await res.sendResponse('AA')
-})
+    await res.sendResponse("AA");
+  },
+);
 ```
-This will create a inbound connection. You can optionally return it to a variable to attach advanced listeners. 
+
+This will create a inbound connection. You can optionally return it to a variable to attach advanced listeners.
 
 ### Client Quick Start
 
 ```ts
 import fastify from "fastify";
 
-fastify.hl7.createClient('localhost', {host: '0.0.0.0'})
+fastify.hl7.createClient("localhost", { host: "0.0.0.0" });
 ```
 
 This will create a "client" class that will then allow you to attach different outbound connections.
-The name ```localhost``` in a unique identifier to this host, so it can be used to attach different outbound connections to this server/broker.
+The name `localhost` in a unique identifier to this host, so it can be used to attach different outbound connections to this server/broker.
 
 There might be times when your HL7 messages need to cross-over to different hosts/server/inbound endpoints and this is how you would get them.
 
-Within your code now you can use the fastify context and access the ```hl7``` decorator,
+Within your code now you can use the fastify context and access the `hl7` decorator,
 and create an outbound connection.
 
 ```ts
 const client = fastify.hl7.createConnection(
-  'ob_adt',
-  {port: 3001},
+  "ob_adt",
+  { port: 3001 },
   async (res) => {
-    const messageRes = res.getMessage()
+    const messageRes = res.getMessage();
     // Your code here. Either a failure or a success, but still do your work here.
-})
+  },
+);
 
 // building a HL7 Message Segment
 const message = app.hl7.buildMessage({
@@ -83,10 +86,10 @@ const message = app.hl7.buildMessage({
     msh_9_1: "ADT",
     msh_9_2: "A01",
     msh_11_1: "D",
-  }
-})
+  },
+});
 
-await client.sendMessage(message)
+await client.sendMessage(message);
 ```
 
 ## Full Documentation
@@ -95,21 +98,19 @@ await client.sendMessage(message)
 
 ### `enableServer`
 
-If this is not set, enableServer will be set to ```true```. You need to set this to ```false``` will turn off the server capabilities.
-
+If this is not set, enableServer will be set to `true`. You need to set this to `false` will turn off the server capabilities.
 
-### ```serverOptions```
+### `serverOptions`
 
 Set this using the options from the [node-hl7-serer](https://github.com/Bugs5382/node-hl7-server/blob/main/README.md) library ServerOptions values to override server creation.
 This could be enabling IPv4 or IPv6 and other server options including TLS. Since you cannot set this after run time, it has to be set during registration.
 
-### External Libraries
+### External Libraries Options
 
-* [node-hl7-client](https://github.com/Bugs5382/node-hl7-client/blob/main/README.md) - For the Client, Parser, and Builder to review their options that can be passed as props.
-* [node-hl7-server](https://github.com/Bugs5382/node-hl7-server/blob/main/README.md) - For the Server to the options that can be passed as props.
+- [node-hl7-client](https://github.com/Bugs5382/node-hl7-client/blob/main/README.md) - For the Client, Parser, and Builder to review their options that can be passed as props.
+- [node-hl7-server](https://github.com/Bugs5382/node-hl7-server/blob/main/README.md) - For the Server to the options that can be passed as props.
 
-Please review the library for more complete documentation.
-A far as this plugin for Fastify, there are no options to pass.
+Please review the libraries for more complete documentation.
 
 ## Acknowledgements
 
@@ -117,4 +118,4 @@ A far as this plugin for Fastify, there are no options to pass.
 
 ## License
 
-Licensed under [MIT](./LICENSE).
+Licensed under [MIT](./LICENSE).

package/lib/cjs/class/hL7Client.js

@@ -35,7 +35,7 @@ class HL7Client {
      * @since 1.0.0
      */
     async closeAll() {
-        this._clientConnections.forEach(outbound => {
+        this._clientConnections.forEach((outbound) => {
             outbound.ports.map(async (port) => {
                 await port.connection.close();
             });
@@ -44,19 +44,19 @@ class HL7Client {
     }
     /**
      * Build a HL7 Batch
-     * @description Create a properly formatted HL7 Batch.
+     *@remarks Create a properly formatted HL7 Batch.
      * @since 1.0.0
      * @param props
      */
     buildBatch(props) {
-        if (typeof props !== 'undefined' && typeof props.text !== 'undefined') {
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('Use processMessage method. This is for building.');
+        if (typeof props !== "undefined" && typeof props.text !== "undefined") {
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("Use processMessage method. This is for building.");
         }
         return new node_hl7_client_1.Batch({ ...props });
     }
     /**
      * Build Date
-     * @description Build a date string based off HL7 Standards
+     *@remarks Build a date string based off HL7 Standards
      * @since 2.1.0
      * @param date
      * @param length Options are 8, 12, or 14 (default)
@@ -66,25 +66,27 @@ class HL7Client {
     }
     /**
      * Build a HL7 File Batch
-     * @description Create a properly formatted HL7 File Batch.
+     *@remarks Create a properly formatted HL7 File Batch.
      * @since 1.0.0
      * @param props
      */
     buildFileBatch(props) {
-        if (typeof props !== 'undefined' && (typeof props.fullFilePath !== 'undefined' || typeof props.fileBuffer !== 'undefined')) {
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('Use readFile or readFileBuffer method. This is for building.');
+        if (typeof props !== "undefined" &&
+            (typeof props.fullFilePath !== "undefined" ||
+                typeof props.fileBuffer !== "undefined")) {
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("Use readFile or readFileBuffer method. This is for building.");
         }
         return new node_hl7_client_1.FileBatch({ ...props });
     }
     /**
      * Build a HL7 Message
-     * @description Create a properly formatted HL7 message.
+     *@remarks Create a properly formatted HL7 message.
      * @since 1.0.0
      * @param props
      */
     buildMessage(props) {
-        if (typeof props !== 'undefined' && typeof props.text !== 'undefined') {
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('Use processMessage method. This is for building.');
+        if (typeof props !== "undefined" && typeof props.text !== "undefined") {
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("Use processMessage method. This is for building.");
         }
         return new node_hl7_client_1.Message({ ...props });
     }
@@ -96,12 +98,12 @@ class HL7Client {
     createClient(name, props) {
         const nameFormat = /[ `!@#$%^&*()+\-=\[\]{};':"\\|,.<>\/?~]/; //eslint-disable-line
         if (nameFormat.test(name)) {
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};\':"\\\\|,.<>\\/?~.');
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};':\"\\\\|,.<>\\/?~.");
         }
         // make sure that this does not exist already...
         this._clientConnections.forEach((connections) => {
             if (connections.name === name) {
-                throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('name must be unique.');
+                throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("name must be unique.");
             }
             // nto in the Client class yet
             // if (client.getHost() === props.host) {
@@ -114,13 +116,13 @@ class HL7Client {
         this._clientConnections.push({
             name,
             client,
-            ports: []
+            ports: [],
         });
         return client;
     }
     /**
      * Create an HL7 Outbound Connection
-     * @description Connect to an HL7 Server/Broker
+     *@remarks Connect to an HL7 Server/Broker
      * @since 1.0.0
      * @param name The name stored within created client connections.
      * @param props
@@ -129,10 +131,10 @@ class HL7Client {
     createConnection(name, props, handler) {
         const nameFormat = /[ `!@#$%^&*()+\-=\[\]{};':"\\|,.<>\/?~]/; //eslint-disable-line
         if (nameFormat.test(name)) {
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};\':"\\\\|,.<>\\/?~.');
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};':\"\\\\|,.<>\\/?~.");
         }
-        const getConnection = this._clientConnections.find(client => client.name === name);
-        if (typeof getConnection !== 'undefined') {
+        const getConnection = this._clientConnections.find((client) => client.name === name);
+        if (typeof getConnection !== "undefined") {
             // make sure port is not used all ready
             getConnection.ports.forEach((outbound) => {
                 if (outbound.port === props.port.toString()) {
@@ -142,11 +144,14 @@ class HL7Client {
             // create outbound port to the server in getConnection.client
             const outbound = new node_hl7_client_1.Connection(getConnection.client, props, handler);
             // add it to the array of known ports. need to know this, so we can get it later if needed.
-            getConnection.ports.push({ port: props.port.toString(), connection: outbound });
+            getConnection.ports.push({
+                port: props.port.toString(),
+                connection: outbound,
+            });
             // return it right away. the user might do something with it.
             return outbound;
         }
-        throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('No valid client. Improper setup of a outbound connection.');
+        throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("No valid client. Improper setup of a outbound connection.");
     }
     /**
      * Get Client by the name
@@ -154,8 +159,8 @@ class HL7Client {
      * @param name
      */
     getClientByName(name) {
-        const connection = this._clientConnections.find(connection => connection.name === name);
-        if (typeof connection !== 'undefined') {
+        const connection = this._clientConnections.find((connection) => connection.name === name);
+        if (typeof connection !== "undefined") {
             return connection.client;
         }
         return undefined;
@@ -167,8 +172,8 @@ class HL7Client {
      */
     getClientConnectionByPort(port) {
         let connection;
-        this._clientConnections.forEach(outbound => {
-            outbound.ports.forEach(aPort => {
+        this._clientConnections.forEach((outbound) => {
+            outbound.ports.forEach((aPort) => {
                 if (aPort.port === port) {
                     connection = aPort.connection;
                 }
@@ -178,7 +183,7 @@ class HL7Client {
     }
     /**
      * Process a HL7
-     * @description A HL7 message that could either be a Message (MSH) or Batch (BHS)
+     *@remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
      * @since 1.0.0
      * @param text Raw HL& String
      */
@@ -192,7 +197,7 @@ class HL7Client {
     }
     /**
      * Read File
-     * @description Pass the correct path of the file you want to read.
+     *@remarks Pass the correct path of the file you want to read.
      * @since 1.0.0
      * @param fullFilePath
      * @returns FileBatch
@@ -206,7 +211,7 @@ class HL7Client {
     }
     /**
      * Read a File Buffer
-     * @description Translate an already Buffered HL7 FHS segment to decode it.
+     *@remarks Translate an already Buffered HL7 FHS segment to decode it.
      * @since 1.0.0
      * @param fileBuffer
      * @returns FileBatch

package/lib/cjs/class/hL7Server.js

@@ -14,8 +14,8 @@ class HL7Server {
      * @param port
      */
     async close(port) {
-        const inbound = this._serverInboundConnections.find(server => server.port === port);
-        if (typeof inbound !== 'undefined') {
+        const inbound = this._serverInboundConnections.find((server) => server.port === port);
+        if (typeof inbound !== "undefined") {
             return await inbound.server.close(); // close the server for all inbound connections
         }
         throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE(`No inbound server listening on port: ${port}`);
@@ -40,13 +40,13 @@ class HL7Server {
     createInbound(name, props, handler) {
         const nameFormat = /[ `!@#$%^&*()+\-=\[\]{};':"\\|,.<>\/?~]/; //eslint-disable-line
         if (nameFormat.test(name)) {
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};\':"\\\\|,.<>\\/?~.');
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};':\"\\\\|,.<>\\/?~.");
         }
         const inbound = new node_hl7_server_1.Inbound(this._server, props, handler);
         this._serverInboundConnections.push({
             name,
             port: props.port.toString(),
-            server: inbound
+            server: inbound,
         });
         return inbound;
     }
@@ -56,8 +56,8 @@ class HL7Server {
      * @param name
      */
     getServerByName(name) {
-        const inbound = this._serverInboundConnections.find(inbound => inbound.name === name);
-        if (typeof inbound !== 'undefined') {
+        const inbound = this._serverInboundConnections.find((inbound) => inbound.name === name);
+        if (typeof inbound !== "undefined") {
             return inbound.server;
         }
         return undefined;
@@ -68,8 +68,8 @@ class HL7Server {
      * @param port
      */
     getServerByPort(port) {
-        const inbound = this._serverInboundConnections.find(inbound => inbound.port === port);
-        if (typeof inbound !== 'undefined') {
+        const inbound = this._serverInboundConnections.find((inbound) => inbound.port === port);
+        if (typeof inbound !== "undefined") {
             return inbound.server;
         }
         return undefined;

package/lib/cjs/errors.js

@@ -7,7 +7,7 @@ exports.errors = void 0;
 const error_1 = __importDefault(require("@fastify/error"));
 exports.errors = {
     /** Error if there is an setup error of the plugin itself. */
-    FASTIFY_HL7_ERR_SETUP_ERRORS: (0, error_1.default)('FASTIFY_HL7_ERR_SETUP_ERRORS', 'Setup error: %s'),
+    FASTIFY_HL7_ERR_SETUP_ERRORS: (0, error_1.default)("FASTIFY_HL7_ERR_SETUP_ERRORS", "Setup error: %s"),
     /** If an invalid usage error was done, this error would pop up. */
-    FASTIFY_HL7_ERR_USAGE: (0, error_1.default)('FASTIFY_HL7_ERR_USAGE', 'Usage error: %s')
+    FASTIFY_HL7_ERR_USAGE: (0, error_1.default)("FASTIFY_HL7_ERR_USAGE", "Usage error: %s"),
 };

package/lib/cjs/index.js

@@ -31,12 +31,12 @@ __exportStar(require("./types.js"), exports);
  * @param connection
  */
 const decorateFastifyInstance = (fastify, _opts, connection) => {
-    if (typeof fastify.hl7 !== 'undefined') {
-        throw new errors_js_1.errors.FASTIFY_HL7_ERR_SETUP_ERRORS('Already registered.');
+    if (typeof fastify.hl7 !== "undefined") {
+        throw new errors_js_1.errors.FASTIFY_HL7_ERR_SETUP_ERRORS("Already registered.");
     }
-    if (typeof fastify.hl7 === 'undefined') {
-        fastify.log.trace('[fastify-hl7] Decorate Fastify');
-        fastify.decorate('hl7', connection);
+    if (typeof fastify.hl7 === "undefined") {
+        fastify.log.trace("[fastify-hl7] Decorate Fastify");
+        fastify.decorate("hl7", connection);
     }
 };
 const fastifyHL7 = (0, fastify_plugin_1.default)(async (fastify, opts) => {
@@ -48,15 +48,17 @@ const fastifyHL7 = (0, fastify_plugin_1.default)(async (fastify, opts) => {
     // A server can host many HL7 Inbound connections via different ports, this is fine.
     // Clients are different as an app could talk to different servers, on many ports.
     // So we need to do something different.
-    const serverInstance = (typeof opts.enableServer !== 'undefined' && opts.enableServer) ? new node_hl7_server_1.default(opts.serverOptions) : undefined;
+    const serverInstance = typeof opts.enableServer !== "undefined" && opts.enableServer
+        ? new node_hl7_server_1.default(opts.serverOptions)
+        : undefined;
     // Server Functions
     let server;
-    if (typeof serverInstance !== 'undefined') {
+    if (typeof serverInstance !== "undefined") {
         // Server Functions
         server = new hL7Server_js_1.HL7Server(serverInstance);
         // before we close fastify, make sure all server instances are closed
-        fastify.addHook('preClose', async () => {
-            if (typeof server !== 'undefined') {
+        fastify.addHook("preClose", async () => {
+            if (typeof server !== "undefined") {
                 await server.closeAll();
             }
         });
@@ -64,8 +66,8 @@ const fastifyHL7 = (0, fastify_plugin_1.default)(async (fastify, opts) => {
     // Client Functions
     const client = new hL7Client_js_1.HL7Client();
     // run these before fastify closes
-    fastify.addHook('preClose', async () => {
-        if (typeof client !== 'undefined') {
+    fastify.addHook("preClose", async () => {
+        if (typeof client !== "undefined") {
             await client.closeAll();
         }
     });
@@ -84,25 +86,25 @@ const fastifyHL7 = (0, fastify_plugin_1.default)(async (fastify, opts) => {
             return client.buildMessage(props);
         },
         closeServer: async function (port) {
-            if (typeof server !== 'undefined') {
+            if (typeof server !== "undefined") {
                 return await server.close(port);
             }
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
         },
         closeServerAll: async () => {
-            if (typeof server !== 'undefined') {
+            if (typeof server !== "undefined") {
                 return await server.closeAll();
             }
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
         },
         createClient: function (name, props) {
             return client.createClient(name, props);
         },
         createInbound: function (name, props, handler) {
-            if (typeof server !== 'undefined') {
+            if (typeof server !== "undefined") {
                 return server.createInbound(name, props, handler);
             }
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
         },
         createConnection: function (name, props, handler) {
             return client.createConnection(name, props, handler);
@@ -114,16 +116,16 @@ const fastifyHL7 = (0, fastify_plugin_1.default)(async (fastify, opts) => {
             return client.getClientConnectionByPort(port);
         },
         getServerByName: function (name) {
-            if (typeof server !== 'undefined') {
+            if (typeof server !== "undefined") {
                 return server.getServerByName(name);
             }
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
         },
         getServerByPort: function (port) {
-            if (typeof server !== 'undefined') {
+            if (typeof server !== "undefined") {
                 return server.getServerByPort(port);
             }
-            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
+            throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
         },
         processHL7: function (text) {
             return client.processHL7(text);
@@ -133,7 +135,7 @@ const fastifyHL7 = (0, fastify_plugin_1.default)(async (fastify, opts) => {
         },
         readFileBuffer: function (fileBuffer) {
             return client.readFileBuffer(fileBuffer);
-        }
+        },
     });
 });
 exports.default = fastifyHL7;

package/lib/cjs/validation.js

@@ -7,7 +7,7 @@ exports.validateOpts = void 0;
  */
 const validateOpts = async (opts) => {
     // Mandatory, Defaulted
-    if (typeof opts.enableServer === 'undefined') {
+    if (typeof opts.enableServer === "undefined") {
         opts.enableServer = true;
     }
     return opts;

package/lib/esm/api.d.ts

@@ -1,7 +1,7 @@
-import { HL7 } from 'fastify';
-import fastifyHL7 from '.';
-import { AServers, FastifyHL7Options } from './decorate.js';
-import { HL7Client } from './class/hL7Client.js';
-import { HL7Server } from './class/hL7Server.js';
+import { HL7 } from "fastify";
+import fastifyHL7 from ".";
+import { AServers, FastifyHL7Options } from "./decorate.js";
+import { HL7Client } from "./class/hL7Client.js";
+import { HL7Server } from "./class/hL7Server.js";
 export default fastifyHL7;
 export { fastifyHL7, HL7, FastifyHL7Options, HL7Client, HL7Server, AServers };

package/lib/esm/api.js

@@ -1,5 +1,5 @@
-import fastifyHL7 from '.';
-import { HL7Client } from './class/hL7Client.js';
-import { HL7Server } from './class/hL7Server.js';
+import fastifyHL7 from ".";
+import { HL7Client } from "./class/hL7Client.js";
+import { HL7Server } from "./class/hL7Server.js";
 export default fastifyHL7;
 export { fastifyHL7, HL7Client, HL7Server };

package/lib/esm/class/hL7Client.d.ts

@@ -1,4 +1,4 @@
-import Client, { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, Connection, Message, OutboundHandler } from 'node-hl7-client';
+import Client, { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, Connection, Message, OutboundHandler } from "node-hl7-client";
 export declare class HL7Client {
     /** @internal */
     private readonly _clientConnections;
@@ -10,14 +10,14 @@ export declare class HL7Client {
     closeAll(): Promise<boolean>;
     /**
      * Build a HL7 Batch
-     * @description Create a properly formatted HL7 Batch.
+     *@remarks Create a properly formatted HL7 Batch.
      * @since 1.0.0
      * @param props
      */
     buildBatch(props?: ClientBuilderOptions): Batch;
     /**
      * Build Date
-     * @description Build a date string based off HL7 Standards
+     *@remarks Build a date string based off HL7 Standards
      * @since 2.1.0
      * @param date
      * @param length Options are 8, 12, or 14 (default)
@@ -25,14 +25,14 @@ export declare class HL7Client {
     buildDate(date: Date, length?: string): string;
     /**
      * Build a HL7 File Batch
-     * @description Create a properly formatted HL7 File Batch.
+     *@remarks Create a properly formatted HL7 File Batch.
      * @since 1.0.0
      * @param props
      */
     buildFileBatch(props?: ClientBuilderFileOptions): FileBatch;
     /**
      * Build a HL7 Message
-     * @description Create a properly formatted HL7 message.
+     *@remarks Create a properly formatted HL7 message.
      * @since 1.0.0
      * @param props
      */
@@ -45,7 +45,7 @@ export declare class HL7Client {
     createClient(name: string, props: ClientOptions): Client;
     /**
      * Create an HL7 Outbound Connection
-     * @description Connect to an HL7 Server/Broker
+     *@remarks Connect to an HL7 Server/Broker
      * @since 1.0.0
      * @param name The name stored within created client connections.
      * @param props
@@ -66,14 +66,14 @@ export declare class HL7Client {
     getClientConnectionByPort(port: string): Connection | undefined;
     /**
      * Process a HL7
-     * @description A HL7 message that could either be a Message (MSH) or Batch (BHS)
+     *@remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
      * @since 1.0.0
      * @param text Raw HL& String
      */
     processHL7(text: string): Message | Batch;
     /**
      * Read File
-     * @description Pass the correct path of the file you want to read.
+     *@remarks Pass the correct path of the file you want to read.
      * @since 1.0.0
      * @param fullFilePath
      * @returns FileBatch
@@ -85,7 +85,7 @@ export declare class HL7Client {
     readFile(fullFilePath: string): FileBatch;
     /**
      * Read a File Buffer
-     * @description Translate an already Buffered HL7 FHS segment to decode it.
+     *@remarks Translate an already Buffered HL7 FHS segment to decode it.
      * @since 1.0.0
      * @param fileBuffer
      * @returns FileBatch