
Security News
Meet Socket at Black Hat and DEF CON 2025 in Las Vegas
Meet Socket at Black Hat & DEF CON 2025 for 1:1s, insider security talks at Allegiant Stadium, and a private dinner with top minds in software supply chain security.
apidoc-plugin-ts
Advanced tools
A plugin for apidoc that injects @apiSuccess params from TypeScript interfaces. Supports extended and nested interfaces.
npm install --save-dev apidoc apidoc-plugin-ts
A custom api-doc param "@apiInterface" is exposed:
@apiInterface (optional path) {INTERFACE_NAME} REPLACE-API-PARAM
Given the following interface:
filename: ./employers.ts
export interface Employer {
/**
* Employer job title
*/
jobTitle: string;
/**
* Employer personal details
*/
personalDetails: {
name: string;
age: number;
}
}
and the following custom param:
@apiInterface (./employers.ts) {Person}
under the hood this would transpile to:
@apiSuccess {String} jobTitle Job title
@apiSuccess {Object} personalDetails Empoyer personal details
@apiSuccess {String} personalDetails.name
@apiSuccess {Number} personalDetails.age
@apiInterface {Person}
.FAQs
A plugin for apidoc leveraging TypeScript interfaces.
The npm package apidoc-plugin-ts receives a total of 8 weekly downloads. As such, apidoc-plugin-ts popularity was classified as not popular.
We found that apidoc-plugin-ts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Meet Socket at Black Hat & DEF CON 2025 for 1:1s, insider security talks at Allegiant Stadium, and a private dinner with top minds in software supply chain security.
Security News
CAI is a new open source AI framework that automates penetration testing tasks like scanning and exploitation up to 3,600× faster than humans.
Security News
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.