Skip to content

Listing properties on an object type does not work #23

@fabien0102

Description

@fabien0102

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy