How to use ts-interface-checker - 10 common examples

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const ICacheItem = t.iface([], {
  "key": "string",
  "value": "any",
  "size": "number",
  "tag": t.opt("string"),
});

export const ILRUCache = t.iface([], {
  "capacity": "number",
  "set": t.func("boolean", t.param("item", "ICacheItem"), t.param("overwrite", "boolean", true)),
  "get": t.func("ICacheItem", t.param("key", "string")),
});

export const MyType = t.union("boolean", "number", "ILRUCache");

export const NumberAlias = t.name("number");

export const NumberAlias2 = t.name("NumberAlias");

export const SomeEnum = t.enumtype({
  "Foo": 0,
  "Bar": 1,
});

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const ITest = t.iface([], {
});

export const INestedLiteralIndexSignature = t.iface([], {
  "nestedIndexSignature": t.iface([], {
  }),
});

const exportedTypeSuite: t.ITypeSuite = {
  ITest,
  INestedLiteralIndexSignature,
};
export default exportedTypeSuite;

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const ILRUCache = t.iface([], {
  "capacity": "number",
  "isReady": "boolean",
  "set": t.func("boolean", t.param("item", "ICacheItem"), t.param("overwrite", "boolean", true)),
  "get": t.func("ICacheItem", t.param("key", "string")),
});

const exportedTypeSuite: t.ITypeSuite = {
  ILRUCache,
};
export default exportedTypeSuite;

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const ITest = t.iface([], {
});

export const INestedLiteralIndexSignature = t.iface([], {
  "nestedIndexSignature": t.iface([], {
  }),
});

const exportedTypeSuite: t.ITypeSuite = {
  ITest,
  INestedLiteralIndexSignature,
};
export default exportedTypeSuite;

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const ITest = t.iface([], {
});

export const INestedLiteralIndexSignature = t.iface([], {
  "nestedIndexSignature": t.iface([], {
  }),
});

const exportedTypeSuite: t.ITypeSuite = {
  ITest,
  INestedLiteralIndexSignature,
};
export default exportedTypeSuite;

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const ICacheItem = t.iface([], {
  "key": "string",
  "value": "any",
  "size": "number",
  "tag": t.opt("string"),
});

export const ILRUCache = t.iface([], {
  "capacity": "number",
  "set": t.func("boolean", t.param("item", "ICacheItem"), t.param("overwrite", "boolean", true)),
  "get": t.func("ICacheItem", t.param("key", "string")),
});

export const MyType = t.union("boolean", "number", "ILRUCache");

export const NumberAlias = t.name("number");

export const NumberAlias2 = t.name("NumberAlias");

export const SomeEnum = t.enumtype({
  "Foo": 0,
  "Bar": 1,
});

export const Direction = t.enumtype({
  "Up": 1,

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const ILRUCache = t.iface([], {
  "capacity": "number",
  "isReady": "boolean",
  "set": t.func("boolean", t.param("item", "ICacheItem"), t.param("overwrite", "boolean", true)),
  "get": t.func("ICacheItem", t.param("key", "string")),
});

const exportedTypeSuite: t.ITypeSuite = {
  ILRUCache,
};
export default exportedTypeSuite;

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const ILRUCache = t.iface([], {
  "capacity": "number",
  "isReady": "boolean",
  "set": t.func("boolean", t.param("item", "ICacheItem"), t.param("overwrite", "boolean", true)),
  "get": t.func("ICacheItem", t.param("key", "string")),
});

const exportedTypeSuite: t.ITypeSuite = {
  ILRUCache,
};
export default exportedTypeSuite;

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const ICacheItem = t.iface([], {
  "key": "string",
  "value": "any",
  "size": "number",
  "tag": t.opt("string"),
});

export const ILRUCache = t.iface([], {
  "capacity": "number",
  "set": t.func("boolean", t.param("item", "ICacheItem"), t.param("overwrite", "boolean", true)),
  "get": t.func("ICacheItem", t.param("key", "string")),
});

export const MyType = t.union("boolean", "number", "ILRUCache");

export const NumberAlias = t.name("number");

export const NumberAlias2 = t.name("NumberAlias");

export const SomeEnum = t.enumtype({
  "Foo": 0,
  "Bar": 1,
});

export const Direction = t.enumtype({
  "Up": 1,
  "Down": 2,

import * as t from "ts-interface-checker";
// tslint:disable:object-literal-key-quotes

export const IMyArrayContainer = t.iface([], {
  "myArray": t.array("number"),
  "myArray2": t.array(t.iface([], {
    "foo": "string",
    "bar": "number",
  })),
  "myArray3": t.array("number"),
  "myArray4": t.tuple("number"),
  "myArray5": t.tuple("number", "number"),
  "myArray6": t.tuple("number", t.union("number", "undefined")),
  "myArray7": t.tuple("number", t.opt("number")),
});

const exportedTypeSuite: t.ITypeSuite = {
  IMyArrayContainer,
};
export default exportedTypeSuite;