feat: adds quartet package

Closes moltar#162

Author: moltar

README.md

@@ -9,6 +9,7 @@
 * [marshal](https://github.com/marcj/marshal.ts)
 * [myzod](https://github.com/davidmdm/myzod)
 * [purify-ts](https://github.com/gigobyte/purify)
+* [quartet](https://github.com/whiteand/ts-quartet)
 * [runtypes](https://github.com/pelotom/runtypes)
 * [toi](https://github.com/hf/toi)
 * [ts-json-validator](https://github.com/ostrowr/ts-json-validator)
@@ -72,17 +73,18 @@ const res = isMyDataValid(data)
 
 ### Data Type Checks Sans `ts-json-validator`
 
-Because `ts-json-validator` is so performant it makes it difficult to see the benchmarks for other packages.
-This benchmark run includes all of the above packages, but excludes `ts-json-validator`.
+Because some packages are so performant it makes it difficult to see the benchmarks for other packages.
 
-#### Node 10.x ([JSON](./results/data-type-sans-ts-json-validator-10.x.json), [CSV](./results/data-type-sans-ts-json-validator-10.x.csv), [SVG](./results/data-type-sans-ts-json-validator-10.x.svg))
+This benchmark run includes all of the above packages, but excludes `ts-json-validator` and `quartet`.
 
-![Bar Graph - Node 10.x](./results/data-type-sans-ts-json-validator-10.x.svg)
+#### Node 10.x ([JSON](./results/data-type-sans-outliers-10.x.json), [CSV](./results/data-type-sans-outliers-10.x.csv), [SVG](./results/data-type-sans-outliers-10.x.svg))
 
-#### Node 12.x ([JSON](./results/data-type-sans-ts-json-validator-12.x.json), [CSV](./results/data-type-sans-ts-json-validator-12.x.csv), [SVG](./results/data-type-sans-ts-json-validator-12.x.svg))
+![Bar Graph - Node 10.x](./results/data-type-sans-outliers-10.x.svg)
 
-![Bar Graph - Node 12.x](./results/data-type-sans-ts-json-validator-12.x.svg)
+#### Node 12.x ([JSON](./results/data-type-sans-outliers-12.x.json), [CSV](./results/data-type-sans-outliers-12.x.csv), [SVG](./results/data-type-sans-outliers-12.x.svg))
 
-#### Node 13.x ([JSON](./results/data-type-sans-ts-json-validator-13.x.json), [CSV](./results/data-type-sans-ts-json-validator-13.x.csv), [SVG](./results/data-type-sans-ts-json-validator-13.x.svg))
+![Bar Graph - Node 12.x](./results/data-type-sans-outliers-12.x.svg)
 
-![Bar Graph - Node 13.x](./results/data-type-sans-ts-json-validator-13.x.svg)
+#### Node 13.x ([JSON](./results/data-type-sans-outliers-13.x.json), [CSV](./results/data-type-sans-outliers-13.x.csv), [SVG](./results/data-type-sans-outliers-13.x.svg))
+
+![Bar Graph - Node 13.x](./results/data-type-sans-outliers-13.x.svg)

cases/index.ts

@@ -8,6 +8,7 @@ import { JsonDecoderCase } from './json-decoder';
 import { MarshalCase } from './marshal';
 import { MyzodCase } from './myzod';
 import { PurifyCase } from './purify-ts';
+import { QuartetCase } from './quartet';
 import { RuntypesCase } from './runtypes';
 import { ToiCase } from './toi';
 import { TsJsonValidatorCase } from './ts-json-validator';
@@ -24,6 +25,7 @@ export const cases = [
   MarshalCase,
   MyzodCase,
   PurifyCase,
+  QuartetCase,
   RuntypesCase,
   ToiCase,
   TsJsonValidatorCase,

cases/quartet.ts

@@ -0,0 +1,31 @@
+import { v } from 'quartet';
+import { Case } from './abstract';
+import { Data } from '../data';
+
+const checkData = v<Data>({
+  number: v.safeInteger,
+  negNumber: v.number,
+  maxNumber: v.number,
+  string: v.string,
+  longString: v.string,
+  boolean: v.boolean,
+  deeplyNested: {
+    foo: v.string,
+    num: v.number,
+    bool: v.boolean,
+  },
+});
+
+export class QuartetCase extends Case implements Case {
+  name = 'quartet';
+
+  validate() {
+    const { data } = this;
+
+    if (checkData(data)) {
+      return data;
+    }
+
+    throw new Error('Invalid');
+  }
+}

index.ts

@@ -8,6 +8,7 @@ import { DATA } from './data';
 import { cases } from './cases';
 import { Case } from './cases/abstract';
 import { TsJsonValidatorCase } from './cases/ts-json-validator';
+import { QuartetCase } from './cases/quartet';
 
 const caseInstances: Case[] = cases.map(caseClass => new caseClass(DATA));
 
@@ -16,7 +17,7 @@ const NODE_VERSION = process.env.NODE_VERSION || process.version;
 
 async function main() {
   await suiteDataTypeValidation();
-  await suiteDataTypeValidationSansTsJsonValidator();
+  await suiteDataTypeValidationSansOutliers();
 }
 main();
 
@@ -30,17 +31,17 @@ async function suiteDataTypeValidation() {
 }
 
 /**
- * Benchmarking suite that performs data type validation only, but skips ts-json-validator
- * because it is such an outlier and it is difficult to look at the performance of other packages.
+ * Benchmarking suite that performs data type validation only, but skips outliers
+ * because it is difficult to look at the performance of other packages.
  *
  * https://en.wikipedia.org/wiki/Data_validation#Data-type_check
  */
-async function suiteDataTypeValidationSansTsJsonValidator() {
-  const cases = caseInstances.filter(
-    caseInstance => !(caseInstance instanceof TsJsonValidatorCase)
-  );
+async function suiteDataTypeValidationSansOutliers() {
+  const cases = caseInstances
+    .filter(caseInstance => !(caseInstance instanceof TsJsonValidatorCase))
+    .filter(caseInstance => !(caseInstance instanceof QuartetCase));
 
-  await run('data-type-sans-ts-json-validator', cases, 'validate');
+  await run('data-type-sans-outliers', cases, 'validate');
 }
 
 async function run(name: string, cases: Case[], methodName: keyof Case) {