hl7-tstd 0.3.1 → 1.0.0-dev.1

package/LICENSE.txt

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 1nandagopal
+   Copyright 2026 1nandagopal
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -2,13 +2,27 @@
 
 A simple package to create, parse & transform HL7 message.
 
+![GitHub License](https://img.shields.io/github/license/1nandagopal/hl7-tstd)
+
+```javascript
+// CJS
+const { HL7 } = require('hl7-tstd');
+```
+
+```javascript
+// ESM
+import { HL7 } from 'hl7-tstd';
+```
+
 ```typescript
-import HL7, { Segment } from 'hl7-tstd';
+// TS
+import { HL7, type Segment } from 'hl7-tstd';
 
 const hl7 = new HL7(raw); // raw: raw HL7 message string
 ```
 
-_Segment_ is only a typescript type.
+> [!WARNING]
+> ⚠️ `Segment` is only a type export aimed at helping with type annotation. Using it for other purposes can lead to runtime exceptions.
 
 ### parseOptions
 
@@ -19,9 +33,9 @@ Additional configs for hl7 parsing and building.
 | fieldDelim     |     `\|`      |               `string`                |
 | repeatingDelim |      `~`      |               `string`                |
 | componentDelim |      `^`      |               `string`                |
-| subCompDelim   |     `\&`      |               `string`                |
+| subCompDelim   |      `&`      |               `string`                |
 | eolDelim       |  `\r?\n\|\r`  | `\r?\n\|\r` \| `\r\n` \| `\n` \| `\r` |
-| buildEolChar   |    `\r\n`     |               `string`                |
+| buildEolChar   |     `\r`      |               `string`                |
 
 ## API References
 
@@ -30,11 +44,11 @@ Additional configs for hl7 parsing and building.
 
 Gets the value from a segment.
 
-| Parameter         |   Type   | Requirement  |
-| :---------------- | :------: | :----------: |
-| field             | `string` | **Required** |
-| repeatingIndex    | `number` |  Default: 0  |
-| subComponentIndex | `number` |  Default: 0  |
+| Parameter         |        Type        | Requirement  |
+| :---------------- | :----------------: | :----------: |
+| field             |      `string`      | **Required** |
+| repeatingIndex    | `number` \| `true` |  Default: 0  |
+| subComponentIndex | `number` \| `true` |  Default: 0  |
 
 Return: `string` | `null`
 
@@ -57,7 +71,7 @@ zyxSegment.get('ZYX'); // ZYX|1|A|B|C|Repeat1~Component1^Component2~SubComp1&Sub
 // Get repeating fields
 zyxSegment.get('ZYX.5'); // Repeat1
 zyxSegment.get('ZYX.5', 2); // SubComp1&SubComp2^Component2
-zyxSegment.get('ZYX.5', -1); // Repeat1~Component1^Component2~SubComp1&SubComp2^Component2~Repeat3
+// zyxSegment.get('ZYX.5', -1); // Repeat1~Component1^Component2~SubComp1&SubComp2^Component2~Repeat3
 
 // Get component
 zyxSegment.get('ZYX.5.1', 1); // Component1
@@ -65,7 +79,7 @@ zyxSegment.get('ZYX.5.1', 1); // Component1
 // Get subcomponent
 zyxSegment.get('ZYX.5.1', 2); // SubComp1
 zyxSegment.get('ZYX.5.1', 2, 1); // SubComp2
-zyxSegment.get('ZYX.5.1', 2, -1); // SubComp1&SubComp2
+// zyxSegment.get('ZYX.5.1', 2, -1); // SubComp1&SubComp2
 ```
 
 </details>
@@ -307,8 +321,9 @@ Here,
 </details>
 
 <details id="transform">
-<summary><code>transform</code> 💀 </summary>
+<summary><code>transform</code> 🗑 </summary>
 
+> [!WARNING]
 > ⚠️ **Deprecated**: This method is triggered internally and doesn't need to be invoked manually.
 
 Transforms the raw HL7 message suitable for manipulation and building.