Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Compiles JSDoc annotated javascript into a Typescript Declaration File (.d.ts).
This library's goal is to be able to take as input a jsdoc annotated source JavaScript file (or many files) and output a single TypeScript Declaration File (.d.ts).
It is distributed as a JSDoc3 template. Running jsdoc with this as the template should result in a TypeScript Definition File.
You can install this module from npm:
$> npm install tsd-jsdoc
To use this module, simply specify it as the template for your normal jsdoc generation.
For example, from the command-line you can do:
$> jsdoc -t node_modules/tsd-jsdoc -r .
Or add this to your JSON configuration:
{
"opts": {
"template": "./node_modules/tsd-jsdoc"
}
}
This library provides almost no validation beyond what jsdoc provides. Meaning if you have invalid jsodc comments, this will likely output an invalid TypeScript Definition File.
Additionally there are things that jsdoc things are fine, that TypeScript does not.
One example would be a member variable marked with @constant
. While that is valid
jsdoc, it is not valid TS:
class MyClass {
const member: number; // ERROR: A class member cannot have the 'const' keyword.
}
So there a few cases like this where the jsdoc is massaged into valid TS.
module:
This syntax is used to link to another module's docs. If you use it to describe the code, it will be ignored.
For example, this JavaScript:
const Loader = require('resource-loader');
/**
* @class
* @extends module:resource-loader/Loader
*/
function MyClass() {
Loader.call(this);
}
MyClass.prototype = Object.create(Loader.prototype);
Will generate this declaration:
class MyClass {
}
Instead you can include their jsdoc commented source or write your own jsdocs to
describe Loader
and then just use @extends Loader
.
Any method or member that has the same name as one in the parent of a child class will be ignored.
For example, this JavaScript:
/**
* @class
*/
class Parent {
constructor() {
/**
* A property.
*
* @member {boolean}
*/
this.someprop = true;
}
}
/**
* @class
* @extends Parent
*/
class Child extends Parent {
constructor() {
/**
* The property again
*
* @member {boolean}
*/
this.someprop = false;
}
}
Will generate this declaration:
class Parent {
someprop: boolean;
}
class Child extends Parent {
}
Tags that describe the code, but support is not implemented are:
@default
- No TS equivalent@deprecated
- No TS equivalent (issue)@event
- No TS equivalent@exports
- Not Yet Implemented@external
- Not Yet Implemented@fires
- No TS equivalent@listens
- No TS equivalent@override
- No TS equivalent (issue)@readonly
- No TS equivalent in v1 (implemented in v2)@this
- No TS equivalent in v1 (implemented in v2)@throws
- No TS equivalentAdditionally, tags that are just metadata and don't actually describe the code are ignored. These are:
@author
@classdesc
@copyright
@description
@example
@file
@license
@requires
@see
@since
@summary
@todo
@tutorial
@version
All other tags should work...
FAQs
Compiles JSDoc annotated javascript into a Typescript Declaration File (.d.ts).
The npm package tsd-jsdoc receives a total of 2,773 weekly downloads. As such, tsd-jsdoc popularity was classified as popular.
We found that tsd-jsdoc 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
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.