@astral/validations 4.10.1 → 4.11.0

package/README.md

@@ -26,6 +26,7 @@
     - [max](#max-string)
     - [email](#email)
     - [guid](#guid)
+    - [length](#length)
     - [pattern](#pattern)
     - [onlyNumber](#onlyNumber)
     - [containsNumbers](#containsNumbers)
@@ -412,6 +413,25 @@ validate('x56a4180-h5aa-42ec-a945-5fd21dec0538');
 
 ---
 
+### length
+
+Проверяет значение на соответствие длине.
+
+```ts
+import { string, length } from '@astral/validations';
+
+const validate = string(length(5));
+
+// undefined
+validate('aaaaa');
+
+
+// { message: 'Кол-во символов должно быть: 5' }
+validate('abc');
+```
+
+---
+
 ### pattern
 
 Проверяет строку на соответствие регулярному выражению.

package/index.d.ts

@@ -21,6 +21,7 @@ export { containsDifferentCases, CONTAINS_DIFFERENT_CASES_ERROR_CODE, } from './
 export { toPlainError } from './toPlainError';
 export { email, LENGTH_EMAIL_ERROR_INFO, INVALID_EMAIL_ERROR_INFO, } from './email';
 export { guid, INVALID_GUID_ERROR_INFO } from './guid';
+export { length, STRING_LENGTH_ERROR_CODE } from './length';
 export { mobilePhone, MOBILE_PHONE_ERROR_INFO } from './mobilePhone';
 export { innUL, INN_UL_ERROR_INFO } from './innUL';
 export { innIP, INN_IP_ERROR_INFO } from './innIP';

package/index.js

@@ -21,6 +21,7 @@ export { containsDifferentCases, CONTAINS_DIFFERENT_CASES_ERROR_CODE, } from './
 export { toPlainError } from './toPlainError';
 export { email, LENGTH_EMAIL_ERROR_INFO, INVALID_EMAIL_ERROR_INFO, } from './email';
 export { guid, INVALID_GUID_ERROR_INFO } from './guid';
+export { length, STRING_LENGTH_ERROR_CODE } from './length';
 export { mobilePhone, MOBILE_PHONE_ERROR_INFO } from './mobilePhone';
 export { innUL, INN_UL_ERROR_INFO } from './innUL';
 export { innIP, INN_IP_ERROR_INFO } from './innIP';

package/length/constants.d.ts

@@ -0,0 +1,2 @@
+import { ErrorCode } from '../core';
+export declare const STRING_LENGTH_ERROR_CODE: ErrorCode;

package/length/constants.js

@@ -0,0 +1,2 @@
+import { createErrorCode } from '../core';
+export const STRING_LENGTH_ERROR_CODE = createErrorCode('stringLength');

package/length/index.d.ts

@@ -0,0 +1,2 @@
+export * from './length';
+export * from './constants';

package/length/index.js

@@ -0,0 +1,2 @@
+export * from './length';
+export * from './constants';

package/length/length.d.ts

@@ -0,0 +1,22 @@
+type LengthParams = {
+    /**
+     * @description Замена стандартного сообщения ошибки.
+     */
+    message?: string;
+};
+/**
+ * @description Проверяет значение на соответствие длине. Работает с: string
+ * @param len - целевой кол-во символов
+ * @example
+ *  // Длина строки должна быть 5 символов
+ *  const validate = string(length(5));
+ *
+ *  // undefined
+ *  validate('aaaaa')
+ *
+ *  // error
+ *  validate('va')
+ *
+ */
+export declare const length: <TLastSchemaValues extends Record<string, unknown>>(len: number, params?: LengthParams) => (value: string, prevCtx?: import("../core").ValidationContext<TLastSchemaValues> | undefined) => import("../core").ValidationResult;
+export {};

package/length/length.js

@@ -0,0 +1,26 @@
+import { createRule } from '../core';
+import { STRING_LENGTH_ERROR_CODE } from './constants';
+/**
+ * @description Проверяет значение на соответствие длине. Работает с: string
+ * @param len - целевой кол-во символов
+ * @example
+ *  // Длина строки должна быть 5 символов
+ *  const validate = string(length(5));
+ *
+ *  // undefined
+ *  validate('aaaaa')
+ *
+ *  // error
+ *  validate('va')
+ *
+ */
+export const length = (len, params) => createRule((value, ctx) => {
+    const currentLength = value.trim().length;
+    if (currentLength !== len) {
+        return ctx.createError({
+            code: STRING_LENGTH_ERROR_CODE,
+            message: (params === null || params === void 0 ? void 0 : params.message) || `Кол-во символов должно быть: ${len}`,
+        });
+    }
+    return undefined;
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astral/validations",
-  "version": "4.10.1",
+  "version": "4.11.0",
   "browser": "./index.js",
   "main": "./index.js",
   "dependencies": {