Add export for resolveManualSegmentParams to AWSXRay (#628)

* Add export for resolveManualSegmentParams to AWSXRay * Update comment --------- Co-authored-by: Jason Terando <[email protected]> Co-authored-by: Jonathan Lee <[email protected]>
aws · Jan 29, 2024 · 1d50325 · 1d50325
1 parent b6fb649
commit 1d50325
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/packages/core/lib/aws-xray.d.ts b/packages/core/lib/aws-xray.d.ts
@@ -58,6 +58,7 @@ export { middleware };
 export {
   getNamespace,
   resolveSegment,
+  resolveManualSegmentParams,
   getSegment,
   setSegment,
   isAutomaticMode,

diff --git a/packages/core/lib/aws-xray.js b/packages/core/lib/aws-xray.js
@@ -276,6 +276,17 @@ var AWSXRay = {
 
   resolveSegment: contextUtils.resolveSegment,
 
+  /**
+   * Resolves the segment or subsegment given manual mode and params on the call required.
+   * @param [Segment|Subsegment] segment - The segment manually provided via params.XraySegment, if provided.
+   * @memberof AWSXRay
+   * @function
+   * @returns {Segment|Subsegment}
+   * @see module:context_utils.resolveManualSegmentParams
+   */
+
+  resolveManualSegmentParams: contextUtils.resolveManualSegmentParams,
+
   /**
    * Returns the current segment or subsegment. For use with automatic mode only.
    * @memberof AWSXRay

diff --git a/packages/core/lib/context_utils.d.ts b/packages/core/lib/context_utils.d.ts
@@ -6,6 +6,8 @@ export function getNamespace(): Namespace;
 
 export function resolveSegment(segment?: Segment | Subsegment | null): Segment | Subsegment | undefined;
 
+export function resolveManualSegmentParams(segment?: Segment | Subsegment | null): Segment | Subsegment | undefined;
+
 export function getSegment(): Segment | Subsegment | undefined;
 
 export function setSegment(segment: Segment | Subsegment): void;