reactjs / reactjs/react-docgen

Functions showing as "unknown" when encased in parentheses

Aperta
#994 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
5h 7m
PR unite (30g)
4

Descrizione

I have a prop that is defined as propName: (() => string) | undefined and the function portion of it is showing as "unknown" for the tsType

Minimal input

interface Props {
  name: (() => string) | undefined
}

const MyComponent = ({name}: Props) => {
  return <div />;
}

Output:

[
  {
    "description": "",
    "displayName": "MyComponent",
    "methods": [],
    "props": {
      "name": {
        "required": true,
        "tsType": {
          "name": "union",
          "raw": "(() => string) | undefined",
          "elements": [
            {
              "name": "unknown"
            },
            {
              "name": "undefined"
            }
          ]
        },
        "description": ""
      }
    }
  }
]

Tested on v8.0.0

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.

Direzione di ricerca

Riproduci il problema utilizzando l’interfaccia Props fornita e l’esempio MyComponent, quindi esamina come viene prodotto il tsType segnalato per il parenthesized function type. Il lavoro è completato quando il function branch viene identificato invece di essere segnalato come "unknown", mentre l’unione include ancora undefined; nell’issue non è indicato alcun percorso di file o test.

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

Valutazione

Stack tecnologico
react, typescript
Ambito
documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.