Skip to content

Commit 6577b2c

Browse files
committed
improve compose method comments
1 parent 36c69a2 commit 6577b2c

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

packages/core/src/util/path.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import range from 'lodash/range';
2828
/**
2929
* Composes a valid JSON pointer with an arbitrary number of unencoded segments.
3030
* This method encodes the segments to escape JSON pointer's special characters.
31-
* Empty segments (i.e. empty strings) are skipped.
31+
* `undefined` segments are skipped.
3232
*
3333
* Example:
3434
* ```ts
@@ -46,7 +46,7 @@ export const compose = (
4646
pointer: string,
4747
...segments: (string | number)[]
4848
): string => {
49-
// Remove undefined segments and encode string segments. Number don't need encoding.
49+
// Remove undefined segments and encode string segments. Numbers don't need encoding.
5050
// Only skip undefined segments, as empty string segments are allowed
5151
// and reference a property that has the empty string as property name.
5252
const sanitizedSegments = segments
@@ -55,7 +55,7 @@ export const compose = (
5555

5656
return sanitizedSegments.reduce(
5757
(currentPointer, segment) => `${currentPointer}/${segment}`,
58-
pointer ?? ''
58+
pointer ?? '' // Treat undefined and null the same as the empty string (root pointer)
5959
);
6060
};
6161

0 commit comments

Comments
 (0)