-
Notifications
You must be signed in to change notification settings - Fork 42
Closed
Labels
Description
Hello,
I'm trying to generate types.d.ts for gitgraph.js
This is my problem:
/**
* GitGraph
* @constructor
* @param {object} options - GitGraph options
* @param {string} [options.elementId = "gitGraph"] - Id of the canvas container
* @param {Template|string|object} [options.template] - Template of the graph
* @param {string} [options.author = "Sergio Flores <saxo-guy@epic.com>"] - Default author for commits
* @param {string} [options.mode = (null|"compact")] - Display mode
* @param {HTMLElement} [options.canvas] - DOM canvas (ex: document.getElementById("id"))
* @param {string} [options.orientation = ("vertical-reverse"|"horizontal"|"horizontal-reverse")] - Graph orientation
* @param {boolean} [options.reverseArrow = false] - Make arrows point to ancestors if true
* @param {number} [options.initCommitOffsetX = 0] - Add custom offsetX to initial commit.
* @param {number} [options.initCommitOffsetY = 0] - Add custom offsetY to initial commit.
* @param {HTMLElement} [options.tooltipContainer = document.body] - HTML Element containing tooltips in compact mode.
* @this GitGraph
*/
declare class GitGraph {
constructor(options: any, options.elementId?: string, options.template?: Template | string | any, options.author?: string, options.mode?: string, options.canvas?: any, options.orientation?: string, options.reverseArrow?: boolean, options.initCommitOffsetX?: number, options.initCommitOffsetY?: number, options.tooltipContainer?: any);
}
My options
is not correctly parsed, idealy I would like to export an interface of GitGraphOptions
but I can't find any jsdoc notations for have the correct output…
If anyone have a simple solution, I take it, otherwise it can be a real issue
Thank you!