Skip to content
This repository has been archived by the owner. It is now read-only.
Experimental JSDoc plugin to generate TypeScript definition files (.d.ts) from JSDoc-annotated source
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
configs Update for OL 4.1.0 Apr 15, 2017
content Update ol baseline to 4.6.2 Dec 7, 2017
examples Add reserved member name example case Dec 12, 2016
plugins Add a patch plugin for falcor to fix docs on Observable and ModelResp… Oct 15, 2016
src Fix TS error Apr 15, 2017
test Update OL baseline to 4.5.0 and fix OL post-processor to generate pie… Nov 15, 2017
tools Update OL baseline to 4.5.0 and fix OL post-processor to generate pie… Nov 15, 2017
typings Update ol baseline to 4.6.2 Dec 7, 2017
.gitignore
.travis.yml - Use yarn instead of npm Feb 16, 2017
CONFIGURATION.md #33: Initial bits of documentation Feb 18, 2016
INTRODUCTION.md #33: Flesh out INTRODUCTION.md Feb 18, 2016
README.md
package.json Update ol baseline to 4.6.2 Dec 7, 2017
tsconfig.json
tsd.json Initial commit Feb 1, 2016
yarn.lock Update ol baseline to 4.6.2 Dec 7, 2017

README.md

No longer maintained

When I started this project, I had the lofty goal of a generic d.ts typings generator that works off of JSDoc annotations for any plain JS project.

In reality, this project had a singular purpose: To generate a 100% coverage TypeScript definition file for the OpenLayers library. This project had fulfilled this singular purpose very well up to the latest 4.x release (4.6.5).

OpenLayers afterwards had changed their module structure to the point that this plugin no longer was able to generate a suitable TypeScript definition. Given there are competing efforts that have made better inroads than I have in this regard, I am no longer maintaining this project and have archived this repository.

If you are after TypeScript support for OpenLayers 5.x and newer, see:

Otherwise, feel free to fork this repo and see what you can do with the code. Good luck!

jsdoc-typescript-plugin

Build Status

JSDoc plugin to automatically generate TypeScript Definitions from annotated source

Building

npm install
npm run-script tsc

The compiled plugin will reside under plugins/typescript.js

Using the plugin

Add the following snippet to your JSDoc configuration

{ "plugins": [ "plugins/typescript" ] }

Refer to configuration for plugin configuration options

Configuration

TBD

You can’t perform that action at this time.