Skip to content

Commit 1d50325

Browse files
jasonterandoJason Terandojj22ee
authored
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]>
1 parent b6fb649 commit 1d50325

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

packages/core/lib/aws-xray.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ export { middleware };
5858
export {
5959
getNamespace,
6060
resolveSegment,
61+
resolveManualSegmentParams,
6162
getSegment,
6263
setSegment,
6364
isAutomaticMode,

packages/core/lib/aws-xray.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,17 @@ var AWSXRay = {
276276

277277
resolveSegment: contextUtils.resolveSegment,
278278

279+
/**
280+
* Resolves the segment or subsegment given manual mode and params on the call required.
281+
* @param [Segment|Subsegment] segment - The segment manually provided via params.XraySegment, if provided.
282+
* @memberof AWSXRay
283+
* @function
284+
* @returns {Segment|Subsegment}
285+
* @see module:context_utils.resolveManualSegmentParams
286+
*/
287+
288+
resolveManualSegmentParams: contextUtils.resolveManualSegmentParams,
289+
279290
/**
280291
* Returns the current segment or subsegment. For use with automatic mode only.
281292
* @memberof AWSXRay

packages/core/lib/context_utils.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ export function getNamespace(): Namespace;
66

77
export function resolveSegment(segment?: Segment | Subsegment | null): Segment | Subsegment | undefined;
88

9+
export function resolveManualSegmentParams(segment?: Segment | Subsegment | null): Segment | Subsegment | undefined;
10+
911
export function getSegment(): Segment | Subsegment | undefined;
1012

1113
export function setSegment(segment: Segment | Subsegment): void;

0 commit comments

Comments
 (0)