Rename MappedObjectSchema -> LiteralObjectSchema

CodeStix · CodeStix · commit 76d3feda6902 · 2021-04-26T15:25:01.000+02:00
diff --git a/src/factory.ts b/src/factory.ts
@@ -5,8 +5,8 @@ import {
     BooleanSchema,
     CustomSchema,
     DateSchema,
-    MappedObjectKeySchemas,
-    MappedObjectSchema,
+    LiteralObjectKeySchemas,
+    LiteralObjectSchema,
     NumberSchema,
     ObjectSchema,
     OrSchema,
@@ -68,15 +68,15 @@ export function value<T extends string | number | boolean | null | undefined>(va
  * @param fields The object and nested validation schemas the value must match.
  * @param requiredMessage The error to return if the value is undefined.
  */
-export function object<T>(fields: MappedObjectKeySchemas<T>, requiredMessage?: string): MappedObjectSchema<T>;
+export function object<T>(fields: LiteralObjectKeySchemas<T>, requiredMessage?: string): LiteralObjectSchema<T>;
 /**
  * Requires this field to be a object, allowing all keys and values.
  * @param requiredMessage The error to return if the value is undefined.
  */
 export function object<T>(requiredMessage?: string): ObjectSchema;
 export function object() {
     if (typeof arguments[0] === "object") {
-        return new MappedObjectSchema(arguments[0], arguments[1]);
+        return new LiteralObjectSchema(arguments[0], arguments[1]);
     } else {
         return new ObjectSchema(arguments[0] ?? arguments[1]);
     }
@@ -143,6 +143,11 @@ export function any(requiredMessage?: string) {
     return new AnySchema(requiredMessage);
 }
 
+/**
+ * Requires this field to be a mapped object type.
+ * @param keySchema The keys of the object must match this schema.
+ * @param valueSchema The values of the object must match this schema.
+ */
 export function mapped<K extends string | number | symbol, V>(keySchema: Schema<K>, valueSchema: Schema<V>): MappedSchema<K, V> {
     return new MappedSchema(keySchema, valueSchema);
 }
diff --git a/src/schemas.ts b/src/schemas.ts
@@ -343,7 +343,7 @@ export class ObjectSchema extends Schema<object> {
     }
 }
 
-export type MappedObjectKeySchemas<T> = {
+export type LiteralObjectKeySchemas<T> = {
     [Key in keyof T]: Schema<T[Key]>;
 };
 
@@ -358,8 +358,8 @@ type MergeIntersection<T> = {
     [Key in keyof T]: T[Key];
 };
 
-export class MappedObjectSchema<T extends {}> extends Schema<MergeIntersection<MakeUndefinedOptional<T>>> {
-    public constructor(protected fields: MappedObjectKeySchemas<T>, requiredMessage?: string) {
+export class LiteralObjectSchema<T extends {}> extends Schema<MergeIntersection<MakeUndefinedOptional<T>>> {
+    public constructor(protected fields: LiteralObjectKeySchemas<T>, requiredMessage?: string) {
         super(requiredMessage);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -343,7 +343,7 @@ export class ObjectSchema extends Schema<object> {`
`343`	`343`	`}`
`344`	`344`	`}`
`345`	`345`
`346`		`-export type MappedObjectKeySchemas<T> = {`
	`346`	`+export type LiteralObjectKeySchemas<T> = {`
`347`	`347`	`[Key in keyof T]: Schema<T[Key]>;`
`348`	`348`	`};`
`349`	`349`
`@@ -358,8 +358,8 @@ type MergeIntersection<T> = {`
`358`	`358`	`[Key in keyof T]: T[Key];`
`359`	`359`	`};`
`360`	`360`
`361`		`-export class MappedObjectSchema<T extends {}> extends Schema<MergeIntersection<MakeUndefinedOptional<T>>> {`
`362`		`- public constructor(protected fields: MappedObjectKeySchemas<T>, requiredMessage?: string) {`
	`361`	`+export class LiteralObjectSchema<T extends {}> extends Schema<MergeIntersection<MakeUndefinedOptional<T>>> {`
	`362`	`+ public constructor(protected fields: LiteralObjectKeySchemas<T>, requiredMessage?: string) {`
`363`	`363`	`super(requiredMessage);`
`364`	`364`	`}`
`365`	`365`