feat: initial commit

Author: moltar

.gitignore

@@ -0,0 +1,98 @@
+
+# Created by https://www.gitignore.io/api/node
+# Edit at https://www.gitignore.io/?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# react / gatsby 
+public/
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# End of https://www.gitignore.io/api/node

README.md

@@ -0,0 +1,5 @@
+# Benchmark Comparison of TypeScript Runtime Type Support Modules
+
+> Write up coming soon...
+
+![][./bar-graph.svg]

bar-graph.svg

@@ -0,0 +1,6 @@
+name,hz
+JSON Encode Decode,79966.79245582566
+runtypes,41973.09084616639
+io-ts,337073.6125561012
+class-validator sync,73694.89411739286
+class-validator async,61958.63602038928

benchmarks.csv

@@ -0,0 +1,53 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`caseClassValidatorAsync should fail min length test 1`] = `
+Array [
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "minLength": "long_string must be longer than or equal to 100 characters",
+    },
+    "property": "long_string",
+    "target": DataType {
+      "boolean": true,
+      "deeplyNested": DeeplyNestedType {
+        "bool": false,
+        "foo": "bar",
+        "num": 1,
+      },
+      "long_string": "",
+      "max_number": 1.7976931348623157e+308,
+      "neg_number": -1,
+      "number": 1,
+      "string": "string",
+    },
+    "value": "",
+  },
+]
+`;
+
+exports[`caseClassValidatorAsync should fail negative number test 1`] = `
+Array [
+  ValidationError {
+    "children": Array [],
+    "constraints": Object {
+      "isNegative": "neg_number must be a negative number",
+    },
+    "property": "neg_number",
+    "target": DataType {
+      "boolean": true,
+      "deeplyNested": DeeplyNestedType {
+        "bool": false,
+        "foo": "bar",
+        "num": 1,
+      },
+      "long_string": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Vivendum intellegat et qui, ei denique consequuntur vix. Semper aeterno percipit ut his, sea ex utinam referrentur repudiandae. No epicuri hendrerit consetetur sit, sit dicta adipiscing ex, in facete detracto deterruisset duo. Quot populo ad qui. Sit fugit nostrum et. Ad per diam dicant interesset, lorem iusto sensibus ut sed. No dicam aperiam vis. Pri posse graeco definitiones cu, id eam populo quaestio adipiscing, usu quod malorum te. Ex nam agam veri, dicunt efficiantur ad qui, ad legere adversarium sit. Commune platonem mel id, brute adipiscing duo an. Vivendum intellegat et qui, ei denique consequuntur vix. Offendit eleifend moderatius ex vix, quem odio mazim et qui, purto expetendis cotidieque quo cu, veri persius vituperata ei nec. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
+      "max_number": 1.7976931348623157e+308,
+      "neg_number": 1,
+      "number": 1,
+      "string": "string",
+    },
+    "value": 1,
+  },
+]
+`;

cases/__snapshots__/class-validator.test.ts.snap

@@ -0,0 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`io-ts should fail min length test 1`] = `"Invalid"`;
+
+exports[`io-ts should fail negative number test 1`] = `"Invalid"`;

cases/__snapshots__/io-ts.test.ts.snap

@@ -0,0 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`runtypes should fail min length test 1`] = `"Failed constraint check"`;
+
+exports[`runtypes should fail negative number test 1`] = `"Failed constraint check"`;

cases/__snapshots__/runtypes.test.ts.snap

@@ -0,0 +1,44 @@
+import { caseClassValidatorSync, caseClassValidatorAsync } from './class-validator'
+import { DATA } from '../data'
+
+describe('caseClassValidatorSync', () => {
+  it('should pass', () => {
+    const res = caseClassValidatorSync(DATA)
+    expect(res).toEqual(DATA)
+
+    if (res) {
+      expect(res.number).toEqual(DATA.number)
+    }
+  })
+
+  it('should fail negative number test', () => {
+    const req = Object.assign({}, DATA, { neg_number: 1 })
+    expect(() => caseClassValidatorSync(req)).toThrow()
+  })
+
+  it('should fail min length test', () => {
+    const req = Object.assign({}, DATA, { long_string: '' })
+    expect(() => caseClassValidatorSync(req)).toThrow()
+  })
+})
+
+describe('caseClassValidatorAsync', () => {
+  it('should pass', async () => {
+    const res = await caseClassValidatorAsync(DATA)
+    expect(res).toEqual(DATA)
+
+    if (res) {
+      expect(res.number).toEqual(DATA.number)
+    }
+  })
+
+  it('should fail negative number test', () => {
+    const req = Object.assign({}, DATA, { neg_number: 1 })
+    return expect(caseClassValidatorAsync(req)).rejects.toMatchSnapshot()
+  })
+
+  it('should fail min length test', () => {
+    const req = Object.assign({}, DATA, { long_string: '' })
+    return expect(caseClassValidatorAsync(req)).rejects.toMatchSnapshot()
+  })
+})

cases/class-validator.test.ts

@@ -0,0 +1,39 @@
+import 'reflect-metadata'
+import { IsNegative, MinLength } from 'class-validator'
+import { Type } from 'class-transformer'
+import { transformAndValidate, transformAndValidateSync } from 'class-transformer-validator'
+import { Data } from '../data'
+
+type DeeplyNested = Data['deeplyNested']
+
+class DeeplyNestedType implements DeeplyNested {
+  foo!: string
+  num!: number
+  bool!: boolean
+}
+
+class DataType implements Data {
+  number!: number
+
+  @IsNegative()
+  neg_number!: number
+
+  max_number!: number
+  string!: string
+
+  @MinLength(100)
+  long_string!: string
+
+  boolean!:boolean
+
+  @Type(() => DeeplyNestedType)
+  deeplyNested!: DeeplyNestedType
+}
+
+export function caseClassValidatorSync(data: Data) {
+  return transformAndValidateSync(DataType, data)
+}
+
+export function caseClassValidatorAsync(data: Data) {
+  return transformAndValidate(DataType, data)
+}

cases/class-validator.ts

@@ -0,0 +1,4 @@
+export * from './json-encode-decode'
+export * from './runtypes'
+export * from './io-ts'
+export * from './class-validator'