Deprecate unicode-segmenter/utils entry (#84)

Author: cometkim

.changeset/famous-pianos-help.md

@@ -0,0 +1,7 @@
+---
+"unicode-segmenter": minor
+---
+
+Deprecated `unicode-segmenter/utils` entry.
+
+Never used internally anymore. It's too simple, better to inline if needed.

README.md

@@ -32,17 +32,16 @@ Unicode® Standard Annex \#29 - [Revision 45](https://www.unicode.org/reports/tr
 
 ## APIs
 
-There are several entries for text segmentation.
+Entries for Unicode text segmentation.
 
 - [`unicode-segmenter/grapheme`](#export-unicode-segmentergrapheme): Segments and counts **extended grapheme clusters**
 - [`unicode-segmenter/intl-adapter`](#export-unicode-segmenterintl-adapter): [`Intl.Segmenter`] adapter
 - [`unicode-segmenter/intl-polyfill`](#export-unicode-segmenterintl-polyfill): [`Intl.Segmenter`] polyfill
 
-And extra utilities for combined use cases.
+And matchers for extra use cases.
 
 - [`unicode-segmenter/emoji`](#export-unicode-segmenteremoji): Matches single codepoint emojis
 - [`unicode-segmenter/general`](#export-unicode-segmentergeneral): Matches single codepoint alphanumerics
-- [`unicode-segmenter/utils`](#export-unicode-segmenterutils): Some utilities for handling codepoints 
 
 ### Export `unicode-segmenter/grapheme`
 [![](https://edge.bundlejs.com/badge?q=unicode-segmenter/grapheme&treeshake=[*])](https://bundlejs.com/?q=unicode-segmenter%2Fgrapheme&treeshake=%5B*%5D)
@@ -187,42 +186,6 @@ import {
 } from 'unicode-segmenter/general';
 ```
 
-### Export `unicode-segmenter/utils`
-[![](https://edge.bundlejs.com/badge?q=unicode-segmenter/utils&treeshake=[*])](https://bundlejs.com/?q=unicode-segmenter%2Futils&treeshake=%5B*%5D)
-
-You can access some internal utilities to deal with JavaScript strings.
-
-#### Example: Handle UTF-16 surrogate pairs
-
-```js
-import {
-  isHighSurrogate,
-  isLowSurrogate,
-  surrogatePairToCodePoint,
-} from 'unicode-segmenter/utils';
-
-const u32 = '😍';
-const hi = u32.charCodeAt(0);
-const lo = u32.charCodeAt(1);
-
-if (isHighSurrogate(hi) && isLowSurrogate(lo)) {
-  const codePoint = surrogatePairToCodePoint(hi, lo);
-  // => equivalent to u32.codePointAt(0)
-}
-```
-
-#### Example: Determine the length of a character
-
-```js
-import { isBMP } from 'unicode-segmenter/utils';
-
-const char = '😍'; // .length = 2
-const cp = char.codePointAt(0);
-
-char.length === isBMP(cp) ? 1 : 2;
-// => true
-```
-
 ## Runtime Compatibility
 
 `unicode-segmenter` uses only fundamental features of ES2015, making it compatible with most browsers.

src/utils.js

@@ -1,20 +1,26 @@
 // @ts-check
 
 /** 
+ * @deprecated never used
+ *
  * @param {number} c UTF-16 code point
  */
 export function isHighSurrogate(c) {
   return 0xd800 <= c && c <= 0xdbff;
 }
 
 /** 
+ * @deprecated never used
+ *
  * @param {number} c UTF-16 code point
  */
 export function isLowSurrogate(c) {
   return 0xdc00 <= c && c <= 0xdfff;
 }
 
 /** 
+ * @deprecated never used
+ *
  * @param {number} hi high surrogate
  * @param {number} lo low surrogate
  */
@@ -23,6 +29,8 @@ export function surrogatePairToCodePoint(hi, lo) {
 }
 
 /**
+ * @deprecated never used
+ *
  * Check if given code point is within the BMP(Basic Multilingual Plane)
  *
  * @param {number} c Unicode code point
@@ -33,6 +41,8 @@ export function isBMP(c) {
 }
 
 /**
+ * @deprecated never used
+ *
  * Check if given code point is within the SMP(Supplementary Multilingual Plane)
  *
  * @param {number} c Unicode code point
@@ -43,6 +53,8 @@ export function isSMP(c) {
 }
 
 /**
+ * @deprecated never used
+ *
  * Check if given code point is within the SIP(Supplementary Ideographic Plane)
  *
  * @param {number} c Unicode code point
@@ -53,6 +65,8 @@ export function isSIP(c) {
 }
 
 /**
+ * @deprecated never used
+ *
  * Check if given code point is within the TIP(Tertiary Ideographic Plane)
  *
  * @param {number} c Unicode code point
@@ -63,6 +77,8 @@ export function isTIP(c) {
 }
 
 /**
+ * @deprecated never used
+ *
  * Check if given code point is within the SSP(Supplementary Special-purpose Plane)
  *
  * @param {number} c Unicode code point