feat(property_key): rename validator to property key from key

TomokiMiyauci · Jun 2, 2023 · db65b8e · db65b8e
1 parent 35b0bec
commit db65b8e
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 22 deletions.
diff --git a/bindings.ts b/bindings.ts
@@ -12,12 +12,12 @@ import {
   shouldBeBut,
 } from "./utils.ts";
 import { EnumValidator } from "./validators/enum.ts";
-import { KeyValidator } from "./validators/key.ts";
 import { RangeValidator } from "./validators/range.ts";
 import { FixedArrayValidator } from "./validators/array/fixed_array.ts";
 import { PropertiesValidator } from "./validators/object/properties.ts";
 import { OptionalValidator } from "./validators/object/optional.ts";
 import { PropertyValueValidator } from "./validators/object/property_value.ts";
+import { PropertyKeyValidator } from "./validators/object/property_key.ts";
 import { NullishValidator } from "./validators/nullish.ts";
 import { FloatValidator } from "./validators/number/float.ts";
 import { IntegerValidator } from "./validators/number/integer.ts";
@@ -478,7 +478,7 @@ export function between<In>(min: In, max: In) {
  * const keyValidator = key(validator);
  * ```
  */
-export const key = /* @__PURE__ */ createInst(KeyValidator);
+export const key = /* @__PURE__ */ createInst(PropertyKeyValidator);
 
 /** Factory for property value validator.
  *

diff --git a/docs/binding.md b/docs/binding.md
@@ -54,7 +54,7 @@ Objects implementing this interface also come with default messages.
 | [optional](#optional)       |     Closure      | OptionalValidator           |             |
 | [enumerator](#enumerator)   |     Closure      | EnumValidator               |     ✅      |
 | [nullish](#nullish)         |      Object      | NullishValidator            |     ✅      |
-| [key](#key)                 |     Closure      | KeyValidator                |             |
+| [key](#key)                 |     Closure      | PropertyKeyValidator        |             |
 | [value](#value)             |     Closure      | PropertyValueValidator      |             |
 | [and](#and)                 |     Closure      | AndValidator                |     ✅      |
 | [or](#or)                   |     Closure      | OrValidator                 |     ✅      |

diff --git a/docs/validator.md b/docs/validator.md
@@ -200,7 +200,6 @@ do narrowing, but check the implementation.
 | Name                        | In                                      |
 | --------------------------- | --------------------------------------- |
 | EnumValidator               | `unknown`                               |
-| KeyValidator                | `{}`                                    |
 | NullishValidator            | `unknown`                               |
 | RangeValidator              | `unknown`                               |
 | PatternValidator            | `string`                                |
@@ -218,6 +217,7 @@ do narrowing, but check the implementation.
 | PropertiesValidator         | `Record<PropertyKey, unknown>`          |
 | OptionalValidator           | `Partial<Record<PropertyKey, unknown>>` |
 | PropertyValueValidator      | `Record<string, unknown>`               |
+| PropertyKeyValidator        | `object`                                |
 | NegativeNumberValidator     | `number` &#124; `bigint`                |
 | NonNegativeNumberValidator  | `number` &#124; `bigint`                |
 | NonPositiveNumberValidator  | `number` &#124; `bigint`                |

diff --git a/mod.ts b/mod.ts
@@ -77,7 +77,6 @@ export {
   ScalarValidator,
 } from "./validators/utils.ts";
 export { EnumValidator } from "./validators/enum.ts";
-export { KeyValidator } from "./validators/key.ts";
 export { NullishValidator } from "./validators/nullish.ts";
 export { RangeValidator } from "./validators/range.ts";
 export { FixedArrayValidator } from "./validators/array/fixed_array.ts";
@@ -99,6 +98,7 @@ export { PositiveNumberValidator } from "./validators/numeric/positive_number.ts
 export { PropertiesValidator } from "./validators/object/properties.ts";
 export { OptionalValidator } from "./validators/object/optional.ts";
 export { PropertyValueValidator } from "./validators/object/property_value.ts";
+export { PropertyKeyValidator } from "./validators/object/property_key.ts";
 export { AndValidator } from "./validators/operators/and.ts";
 export { EqualityValidator } from "./validators/operators/equality.ts";
 export { GreaterThanValidator } from "./validators/operators/greater_than.ts";

diff --git a/validators/key.ts → validators/object/property_key.ts b/validators/key.ts → validators/object/property_key.ts
@@ -2,32 +2,32 @@
 // Copyright 2023-latest Tomoki Miyauchi. All rights reserved. MIT license.
 // This module is browser compatible.
 
-import { BasicValidator } from "./utils.ts";
-import { curryR } from "../deps.ts";
-import { fromPath, print } from "../utils.ts";
-import { map } from "../iter_utils.ts";
-import { type ValidationFailure, type Validator } from "../types.ts";
+import { BasicValidator } from "../utils.ts";
+import { curryR } from "../../deps.ts";
+import { fromPath, print } from "../../utils.ts";
+import { map } from "../../iter_utils.ts";
+import { type ValidationFailure, type Validator } from "../../types.ts";
 
 /** Property key validator. It checks to pass all property key.
  *
  * @example
  * ```ts
- * import { KeyValidator } from "https://deno.land/x/abstruct@$VERSION/validators/key.ts";
+ * import { PropertyKeyValidator } from "https://deno.land/x/abstruct@$VERSION/validators/object/property_key.ts";
  * import { type Validator } from "https://deno.land/x/abstruct@$VERSION/types.ts";
  * declare const validator: Validator<string>;
- * const keyValidator = new KeyValidator(validator);
+ * const keyValidator = new PropertyKeyValidator(validator);
  * ```
  */
-export class KeyValidator<T extends string = string>
-  extends BasicValidator<{}, Record<T, unknown>> {
+export class PropertyKeyValidator<T extends string = string>
+  extends BasicValidator<object, Record<T, unknown>> {
   validator: Validator<string, T>;
 
   constructor(validator: Readonly<Validator<string, T>>) {
     super();
     this.validator = validator;
   }
 
-  *validate(input: {}): Iterable<ValidationFailure> {
+  *validate(input: object): Iterable<ValidationFailure> {
     for (const key in input) {
       const createError = curryR(fromPath, key);
 

diff --git a/validators/key_test.ts → validators/object/property_key_test.ts b/validators/key_test.ts → validators/object/property_key_test.ts
@@ -1,13 +1,13 @@
 // Copyright 2023-latest Tomoki Miyauchi. All rights reserved. MIT license.
 
-import { KeyValidator } from "./key.ts";
-import { ValidationFailure } from "../types.ts";
-import { PatternValidator } from "./string/pattern.ts";
-import { assertEquals, describe, it } from "../_dev_deps.ts";
+import { PropertyKeyValidator } from "./property_key.ts";
+import { ValidationFailure } from "../../types.ts";
+import { PatternValidator } from "../string/pattern.ts";
+import { assertEquals, describe, it } from "../../_dev_deps.ts";
 
-describe("KeyValidator", () => {
+describe("PropertyKeyValidator", () => {
   it("validate should yield failures", () => {
-    const validator = new KeyValidator(new PatternValidator(/^a/));
+    const validator = new PropertyKeyValidator(new PatternValidator(/^a/));
 
     assertEquals([...validator.validate({ b: "", bb: "" })], [
       new ValidationFailure("", { instancePath: ["b"] }),
@@ -16,7 +16,7 @@ describe("KeyValidator", () => {
   });
 
   it("should represent of", () => {
-    const validator = new KeyValidator(new PatternValidator(/^a/));
+    const validator = new PropertyKeyValidator(new PatternValidator(/^a/));
 
     assertEquals(validator.toString(), "key of pattern of \`\/^a\/\`");
   });