ts-interface-builder

v0.3.3

Compile TypeScript interfaces into a description that allows runtime validation For more information about how to use this package see README

Latest version published 3 years ago

License: Apache-2.0

NPM

GitHub

Package Health Score

51 / 100

security
Security review needed
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.3.3	\|	02/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.3	\|	11/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.8	\|	01/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (17,125)

GitHub Stars: 132
Forks: 28
Contributors: 20

Direct Usage Popularity

The npm package ts-interface-builder receives a total of 17,125 downloads a week. As such, we scored ts-interface-builder popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package ts-interface-builder, we found that it has been starred 132 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the ts-interface-builder repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like ts-interface-builder is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 10
Open PR: 11
Last Release: 3 years ago
Last Commit: 3 years ago

Further analysis of the maintenance status of ts-interface-builder based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for ts-interface-builder is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 4 Direct
Versions: 17
Install Size: 46.6 kB
Dist-tags: 1
# of Files: 21
Maintainers: 2
TS Typings: Yes

ts-interface-builder has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

ts-interface-builder

> Compile TypeScript interfaces into a description that allows runtime validation.

This tool runs at build time to create runtime validators from TypeScript interfaces. It allows validating data, such as parsed JSON objects received over the network, or parsed JSON or YAML files, to check if they satisfy a TypeScript interface, and to produce informative error messages if they do not.

Installation

npm install --save-dev ts-interface-builder
npm install --save ts-interface-checker

Usage

This module works together with ts-interface-checker module. You use ts-interface-builder in a build step that converts some TypeScript interfaces to a new TypeScript or JavaScript file (with -ti.ts or -ti.js extension) that provides a runtime description of the interface. You then use ts-interface-checker in your program to create validator functions from this runtime description.

`npm bin`/ts-interface-builder [options]

By default, produces -ti.ts file for each input file, which has runtime definitions for all types in the input file. For example, if you have a TypeScript file that defines some types:

// foo.ts
interface Square {
  size: number;
  color?: string;
}

Then you can generate code for runtime checks with:

`npm bin`/ts-interface-builder foo.ts

It produces a file like this:

// foo-ti.ts
import * as t from "ts-interface-checker";

export const Square = t.iface([], {
  "size": "number",
  "color": t.opt("string"),
});

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

See ts-interface-checker module for how to use this file in your program.

Limitations

This module currently does not support generics, except Promises. Promises are supported by unwrapping Promise to simply T.

ts-interface-builder dependencies

commander fs-extra typescript glob

ts-interface-builder development dependencies

@babel/core @types/babel-plugin-macros @types/fs-extra @types/glob @types/mocha @types/node babel-plugin-macros fs-extra mocha ts-interface-checker ts-node

FAQs

What is ts-interface-builder?

Compile TypeScript interfaces into a description that allows runtime validation. Visit Snyk Advisor to see a full health score report for ts-interface-builder, including popularity, security, maintenance & community analysis.

Is ts-interface-builder popular?

The npm package ts-interface-builder receives a total of 17,125 weekly downloads. As such, ts-interface-builder popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ts-interface-builder well maintained?

We found indications that ts-interface-builder is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is ts-interface-builder safe to use?

While scanning the latest version of ts-interface-builder, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 20 November-2024, at 11:21 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (17,125)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

ts-interface-builder

Installation

Usage

Limitations

ts-interface-builder dependencies

ts-interface-builder development dependencies

FAQs

What is ts-interface-builder?

Is ts-interface-builder popular?

Is ts-interface-builder well maintained?

Is ts-interface-builder safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues