npmpackage.info

Gathering detailed insights and metrics for ts-interface-keys-transformer

Other packages similar to ts-interface-keys-transformer

ts-interface-keys-transformer-plugin

1.0.2

It parses the interface information during the compilation phase of TypeScript.

ts-interface-key

1.0.7

`ts-interface-key` is inspired by [ts-transformer-keys](https://github.com/kimamula/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.

ts-transform-contextual-keys

1.0.0

TypeScript custom transformer able to extract interface keys contextually

Gathering detailed insights and metrics for ts-interface-keys-transformer

ts-interface-keys-transformer - 2.3.2 | npmpackage.info

ts-interface-keys-transformer

2.3.2

MIT

TypeScript

1.7

Installations

npm install ts-interface-keys-transformer

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

10.19.0

NPM Version

6.13.4 Pull Requests

Open

13

Total

18

Closed

1

Merged

4

Issues

Open

4

Total

5

Closed

1

Releases

Unable to fetch releases

Languages

TypeScript

JavaScript

TypeScript (98.42%)

JavaScript (1.58%)

Developer

nullcc

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

28 Stars

49 Commits

8 Forks

14 Branches

1 Contributors

Updated on Jun 04, 2025

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

2.3.2

Package Id

ts-interface-keys-transformer@2.3.2

Size

5.63 kB

NPM Version

6.13.4

Node Version

10.19.0

Published on

Aug 05, 2020

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

lodash

Dev Dependencies

@types/jest @types/lodash @types/node jest ts-jest typescript

ts-interface-keys-transformer

ts-interface-keys-transformer 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-keys-transformer

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

1"plugins": [
2      { "transform": "ts-interface-keys-transformer/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-keys-transformer';
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-keys-transformer';
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-keys-transformer';
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-keys-transformer';
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

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

43 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More