Merge pull request #472 from shimataro/develop

version 3.0.0-rc.7

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.0.0-rc.7] - 2020-06-11
+
+### Fixed
+
+* TypeScript Generics
+
 ## [3.0.0-rc.6] - 2020-06-11
 
 ### Fixed
@@ -471,7 +477,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 * First release.
 
-[Unreleased]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.6...HEAD
+[Unreleased]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.7...HEAD
+[3.0.0-rc.7]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.6...v3.0.0-rc.7
 [3.0.0-rc.6]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.5...v3.0.0-rc.6
 [3.0.0-rc.5]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.4...v3.0.0-rc.5
 [3.0.0-rc.4]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.3...v3.0.0-rc.4

examples/example-deno.ts

@@ -1,6 +1,21 @@
 import * as assert from "https://deno.land/std/testing/asserts.ts";
 import vs from "../mod.ts";
 
+interface Input {
+	id: number;
+	name: string;
+	age: number;
+	email: string;
+	state: string;
+	classes: number[];
+	skills: string[];
+	creditCard: string;
+	remoteAddr: string;
+	remoteAddrIpv6: string;
+	limit: number,
+	offset: number,
+};
+
 const schemaObject: vs.SchemaObject = { // schema for input
 	id: vs.number({ // number, >=1
 		minValue: 1,
@@ -93,7 +108,7 @@ const expected = { // should be converted to this
 };
 
 // Let's apply!
-const actual = vs.applySchemaObject(schemaObject, input);
+const actual = vs.applySchemaObject<Input>(schemaObject, input);
 
 // verification
 assert.assertEquals(actual, expected);

examples/example.ts

@@ -1,6 +1,21 @@
 import assert from "assert";
 import vs from "value-schema";
 
+interface Input {
+	id: number;
+	name: string;
+	age: number;
+	email: string;
+	state: string;
+	classes: number[];
+	skills: string[];
+	creditCard: string;
+	remoteAddr: string;
+	remoteAddrIpv6: string;
+	limit: number,
+	offset: number,
+};
+
 const schemaObject: vs.SchemaObject = { // schema for input
 	id: vs.number({ // number, >=1
 		minValue: 1,
@@ -93,7 +108,7 @@ const expected = { // should be converted to this
 };
 
 // Let's apply!
-const actual = vs.applySchemaObject(schemaObject, input);
+const actual = vs.applySchemaObject<Input>(schemaObject, input);
 
 // verification
 assert.deepStrictEqual(actual, expected);

package.json

@@ -1,7 +1,7 @@
 {
   "name": "value-schema",
   "description": "simple, easy-to-use, and declarative schema validator",
-  "version": "3.0.0-rc.6",
+  "version": "3.0.0-rc.7",
   "author": "shimataro",
   "license": "MIT",
   "repository": {

src/libs/applySchemaObject.ts

@@ -1,7 +1,7 @@
 import {SchemaObject, applySchemaObjectCore} from "./applySchemaObjectCore";
 import {ErrorHandler, FinishHandler, onErrorDefault, onFinishedDefault} from "./BaseSchema";
 
-import {AnyObject} from "../libs/types";
+import {Empty} from "../libs/types";
 
 export {SchemaObject} from "./applySchemaObjectCore";
 export {ErrorHandler} from "./BaseSchema";
@@ -14,7 +14,7 @@ export {ErrorHandler} from "./BaseSchema";
  * @param onFinished finish handler
  * @returns applied data
  */
-export function applySchemaObject<T extends AnyObject>(schemaObject: SchemaObject, data: unknown, onError: ErrorHandler = onErrorDefault, onFinished: FinishHandler = onFinishedDefault): T
+export function applySchemaObject<T extends Empty>(schemaObject: SchemaObject, data: unknown, onError: ErrorHandler = onErrorDefault, onFinished: FinishHandler = onFinishedDefault): T
 {
 	return applySchemaObjectCore(schemaObject, data, onError, onFinished, []);
 }

src/libs/applySchemaObjectCore.ts

@@ -1,4 +1,4 @@
-import {AnyObject, Key, isObject} from "./types";
+import {AnyObject, Empty, Key, isObject} from "./types";
 import {BaseSchema, ErrorHandler, FinishHandler} from "./BaseSchema";
 import {CAUSE, ValueSchemaError} from "./ValueSchemaError";
 
@@ -13,7 +13,7 @@ export type SchemaObject = Record<string, BaseSchema>
  * @param keyStack path to key that caused error
  * @returns applied data
  */
-export function applySchemaObjectCore<T extends AnyObject>(schemaObject: SchemaObject, data: unknown, onError: ErrorHandler, onFinished: FinishHandler, keyStack: Key[]): T
+export function applySchemaObjectCore<T extends Empty>(schemaObject: SchemaObject, data: unknown, onError: ErrorHandler, onFinished: FinishHandler, keyStack: Key[]): T
 {
 	if(!isObject(data))
 	{

src/libs/types.ts

@@ -2,6 +2,10 @@ type Scalar = boolean | number | string;
 
 export type AnyObject = Record<string, unknown>;
 
+export interface Empty
+{
+}
+
 export type Key = string | number;
 
 export interface Values<T = unknown>