Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[BUG]: incorrect `downloadImage` type definition

Abierto Apto para principiantes
#8,072 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
85/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
javascript, typescript
Área
documentation

Línea de trabajo

El issue apunta a la definición de tipo para downloadImage en las definiciones de TypeScript. Revisa el archivo fuente src/snapshot/download.js para ver cómo se maneja opts (permite valores nullish). Luego, actualiza la definición de TypeScript para hacer que el parámetro opts sea opcional, coincidiendo con el comportamiento de toImage. Verifica probando el cambio con una compilación simple de TypeScript.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug
Description

I'm happy to see type definitions about image export features were improved in recent PR #8066. Let me point out a minor type problem that (I think) remains after the PR.

The second parameter opts in downloadImage() function is required but I think it should be optional. That in toImage() is optional.

export function downloadImage(root: RootOrData, opts: DownloadImgopts): Promise<string>;

Because of this, a TS compiler complains about Plotly.downloadImage('graphDiv'), while it works as JS code. It seems the source code (src/snapshot/download.js) allows opts to be nullish.

There is a workaround such as calling Plotly.downloadImage('graphDiv', {}), and so this problem is not serious. I would be happy if it were fixed in future.

Lenguaje dominante
JavaScript
Estrellas
18.3k
Forks
2k
Merge medio
2 d 10 h
PR fusionados (30 d)
30

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de plotly/plotly.js

Todos los issues de plotly/plotly.js

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.