Browse Source

docs: updates README.md

e22m4u 3 weeks ago
parent
commit
359b0b5e4c
3 changed files with 6 additions and 6 deletions
  1. 3 3
      README.md
  2. 1 1
      src/data-parser.js
  3. 2 2
      src/data-validator.js

+ 3 - 3
README.md

@@ -133,7 +133,7 @@ const validator = new DataValidator();
 // значение "str" соответствует схеме
 validator.validate('str', schema); // OK
 
-// undefined допускается (нет опции "required")
+// undefined допускается (параметр "required" не указан)
 validator.validate(undefined, schema); // OK
 
 // 10 не является строкой
@@ -159,7 +159,7 @@ const schema = {
 // значение 10 соответствует схеме
 validator.validate(10, schema); // OK
 
-// undefined не допускается (опция "required")
+// undefined не допускается (параметр "required")
 validator.validate(undefined, schema); // error: DataValidationError
 
 // 'str' не является числом
@@ -193,7 +193,7 @@ validator.validate([], schema); // OK
 // 'str' не является массивом
 validator.validate('str', schema); // error: DataValidationError
 
-// элементы массива не соответствуют схеме (опция "items")
+// элементы массива не соответствуют схеме (параметр "items")
 validator.validate(['a', 'b'], schema); // error: DataValidationError
 
 // объект не является массивом

+ 1 - 1
src/data-parser.js

@@ -163,7 +163,7 @@ export class DataParser extends Service {
     if (!shallowMode) {
       // если значение является массивом, то выполняется
       // преобразование каждого элемента по схеме, указанной
-      // в опции items
+      // в параметре items
       if (Array.isArray(value) && schema.items !== undefined) {
         // чтобы избежать изменения оригинального массива,
         // выполняется его поверхностное копирование

+ 2 - 2
src/data-validator.js

@@ -155,7 +155,7 @@ export class DataValidator extends Service {
       return;
     }
     // если значение является массивом, то проверяется
-    // каждый элемент по схеме, указанной в опции items
+    // каждый элемент по схеме, указанной в параметре items
     if (Array.isArray(value) && schema.items !== undefined) {
       value.forEach((item, index) => {
         const itemPath = (sourcePath || 'array') + `[${index}]`;
@@ -164,7 +164,7 @@ export class DataValidator extends Service {
       });
     }
     // если значение является объектом, то проверяется
-    // значение каждого свойства по схеме опции properties
+    // значение каждого свойства по параметру properties
     else if (
       value !== null &&
       typeof value === 'object' &&