Refactor byte count in byte actions

fabian-hiller · Oct 11, 2024 · 1ecad75 · 1ecad75
1 parent 2cf6025
commit 1ecad75
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 8 deletions.
diff --git a/library/CHANGELOG.md b/library/CHANGELOG.md
@@ -7,6 +7,7 @@ All notable changes to the library will be documented in this file.
 - Add `checkItemsAsync` action (pull request #856)
 - Add `graphemes`, `maxGraphemes`, `minGraphemes` and `notGraphemes` action (pull request #853)
 - Change types and implementation to support Standard Schema
+- Refactor `bytes`, `maxBytes`, `minBytes` and `notBytes` action
 
 ## v0.42.1 (September 20, 2024)
 

diff --git a/library/src/actions/bytes/bytes.ts b/library/src/actions/bytes/bytes.ts
@@ -3,7 +3,7 @@ import type {
   BaseValidation,
   ErrorMessage,
 } from '../../types/index.ts';
-import { _addIssue } from '../../utils/index.ts';
+import { _addIssue, _getByteCount } from '../../utils/index.ts';
 
 /**
  * Bytes issue type.
@@ -110,7 +110,7 @@ export function bytes(
     message,
     '~validate'(dataset, config) {
       if (dataset.typed) {
-        const length = new TextEncoder().encode(dataset.value).length;
+        const length = _getByteCount(dataset.value);
         if (length !== this.requirement) {
           _addIssue(this, 'bytes', dataset, config, {
             received: `${length}`,

diff --git a/library/src/actions/maxBytes/maxBytes.ts b/library/src/actions/maxBytes/maxBytes.ts
@@ -3,7 +3,7 @@ import type {
   BaseValidation,
   ErrorMessage,
 } from '../../types/index.ts';
-import { _addIssue } from '../../utils/index.ts';
+import { _addIssue, _getByteCount } from '../../utils/index.ts';
 
 /**
  * Max bytes issue type.
@@ -115,7 +115,7 @@ export function maxBytes(
     message,
     '~validate'(dataset, config) {
       if (dataset.typed) {
-        const length = new TextEncoder().encode(dataset.value).length;
+        const length = _getByteCount(dataset.value);
         if (length > this.requirement) {
           _addIssue(this, 'bytes', dataset, config, {
             received: `${length}`,

diff --git a/library/src/actions/minBytes/minBytes.ts b/library/src/actions/minBytes/minBytes.ts
@@ -3,7 +3,7 @@ import type {
   BaseValidation,
   ErrorMessage,
 } from '../../types/index.ts';
-import { _addIssue } from '../../utils/index.ts';
+import { _addIssue, _getByteCount } from '../../utils/index.ts';
 
 /**
  * Min bytes issue type.
@@ -115,7 +115,7 @@ export function minBytes(
     message,
     '~validate'(dataset, config) {
       if (dataset.typed) {
-        const length = new TextEncoder().encode(dataset.value).length;
+        const length = _getByteCount(dataset.value);
         if (length < this.requirement) {
           _addIssue(this, 'bytes', dataset, config, {
             received: `${length}`,

diff --git a/library/src/actions/notBytes/notBytes.ts b/library/src/actions/notBytes/notBytes.ts
@@ -3,7 +3,7 @@ import type {
   BaseValidation,
   ErrorMessage,
 } from '../../types/index.ts';
-import { _addIssue } from '../../utils/index.ts';
+import { _addIssue, _getByteCount } from '../../utils/index.ts';
 
 /**
  * Not bytes issue type.
@@ -115,7 +115,7 @@ export function notBytes(
     message,
     '~validate'(dataset, config) {
       if (dataset.typed) {
-        const length = new TextEncoder().encode(dataset.value).length;
+        const length = _getByteCount(dataset.value);
         if (length === this.requirement) {
           _addIssue(this, 'bytes', dataset, config, {
             received: `${length}`,

diff --git a/library/src/utils/_getByteCount/_getByteCount.test.ts b/library/src/utils/_getByteCount/_getByteCount.test.ts
@@ -0,0 +1,12 @@
+import { describe, expect, test } from 'vitest';
+import { _getByteCount } from './_getByteCount.ts';
+
+describe('_getByteCount', () => {
+  test('should return byte count', () => {
+    expect(_getByteCount('hello world')).toBe(11);
+    expect(_getByteCount('😀')).toBe(4);
+    expect(_getByteCount('🧑🏻‍💻')).toBe(15);
+    expect(_getByteCount('𝄞')).toBe(4);
+    expect(_getByteCount('สวัสดี')).toBe(18);
+  });
+});
diff --git a/library/src/utils/_getByteCount/_getByteCount.ts b/library/src/utils/_getByteCount/_getByteCount.ts
@@ -0,0 +1,17 @@
+let textEncoder: TextEncoder;
+
+/**
+ * Returns the byte count of the input.
+ *
+ * @param input The input to be measured.
+ *
+ * @returns The byte count.
+ *
+ * @internal
+ */
+export function _getByteCount(input: string): number {
+  if (!textEncoder) {
+    textEncoder = new TextEncoder();
+  }
+  return textEncoder.encode(input).length;
+}
diff --git a/library/src/utils/_getByteCount/index.ts b/library/src/utils/_getByteCount/index.ts
@@ -0,0 +1 @@
+export * from './_getByteCount.ts';
diff --git a/library/src/utils/index.ts b/library/src/utils/index.ts
@@ -1,4 +1,5 @@
 export * from './_addIssue/index.ts';
+export * from './_getByteCount/index.ts';
 export * from './_getGraphemeCount/index.ts';
 export * from './_isLuhnAlgo/index.ts';
 export * from './_isValidObjectKey/index.ts';