ts-interface-key

ts-interface-key is inspired by ts-transformer-keys. It uses a custom transformer to parse the keys in 'interface' and 'type' in compile stage in TypeScript which support nested keys and optionality.

Usage

1$ npm i -D typescript ttypescript ts-interface-key

and then add following to "compilerOptions" field in tsconfig.json:

1"plugins": [
2      { "transform": "ts-interface-key/transformer" }
3    ]

Use following command to run (assume index.js is the compiled file of index.ts):

1$ ttsc -p tsconfig.json && node index.js

Works With Simple Interface

1import { keys } from 'ts-interface-key';
2
3interface Foo {
4  a: string;
5  readonly b: number;
6  c?: boolean;
7}
8// [ { name: 'a', modifiers: [], optional: false, type: 'string' },
9//   { name: 'b', modifiers: [ 'readonly' ], optional: false, type: 'number' },
10//   { name: 'c', modifiers: [], optional: true, type: 'boolean' } ]
11console.log(keys<Foo>());

Works With Complex Interface

1import { keys } from 'ts-interface-key';
2
3interface Foo {
4  a: string;
5  b: {
6    b1: string;
7    b2: number;
8  },
9  c: string[];
10  d: Array<{
11    d1: string;
12    d2: number;
13  }>;
14}
15// [ { "name": "a", "modifiers": [], "optional": false, "type": "string" },
16//   { "name": "b", "modifiers": [], "optional": false, "type": "object" },
17//   { "name": "b.b1", "modifiers": [], "optional": false, "type": "string" },
18//   { "name": "b.b2", "modifiers": [], "optional": false, "type": "number" },
19//   { "name": "c", "modifiers": [], "optional": false, "type": "array", "elementType": "string" },
20//   {
21//     "name": "d",
22//     "modifiers": [],
23//     "optional": false,
24//     "type": "Array",
25//     "elementKeys": [
26//       {
27//         "name": "d1",
28//         "modifiers": [],
29//         "optional": false,
30//         "type": "string"
31//       },
32//       {
33//         "name": "d2",
34//         "modifiers": [],
35//         "optional": false,
36//         "type": "number"
37//       }
38//     ]
39//   } ]
40console.log(keys<Foo>());

Works With Intersection Type

1import { keys } from 'ts-interface-key';
2
3interface Foo {
4  a: string;
5}
6interface Bar {
7  b: string;
8}
9// [ { "name": "a", "modifiers": [], "optional": false, "type": "string" },
10//   { "name": "b", "modifiers": [], "optional": false, "type": "string" } ]
11console.log(keys<Foo & Bar>());

Works With Union Type

1import { keys } from 'ts-interface-key';
2
3interface Foo {
4  a: string;
5}
6interface Bar {
7  a: string;
8  b: string;
9}
10// [ { "name": "a", "modifiers": [], "optional": false, "type": "string"} ]
11console.log(keys<Foo | Bar>());

See more test cases in Tests

Build

1npm run build

Run Tests

1npm test