Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[BUG]: incorrect `downloadImage` type definition

Aperta Adatta ai principianti
#8,072 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
85/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript, typescript
Ambito
documentation

Direzione di ricerca

L'issue punta alla definizione del tipo per downloadImage nelle definizioni TypeScript. Controlla il file sorgente src/snapshot/download.js per vedere come viene gestito opts (consente valori nullish). Quindi aggiorna la definizione TypeScript per rendere il parametro opts opzionale, in linea con il comportamento di toImage. Verifica testando la modifica con una semplice compilazione TypeScript.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
JavaScript
Stelle
18.3k
Fork
2k
Merge medio
2g 10h
PR unite (30g)
30

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di plotly/plotly.js

Tutte le issue di plotly/plotly.js

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.