`PrimaryData` should include `null`

Aperta
#180 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
api

Direzione di ricerca

Esamina le definizioni TypeScript per PrimaryData e DocWithData, iniziando dalla dichiarazione che tipizza la proprietà data del documento. Verifica la specifica JSON:API di livello superiore citata nell'issue e aggiungi o aggiorna la copertura dei tipi pertinente, in modo che un documento con data: null superi il controllo dei tipi.

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

Descrizione

The JSON:API spec says:

Primary data MUST be either:

  • a single resource object, a single resource identifier object, or null, for requests that target single resources
  • an array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections

Note "or null" in the first condition.

So the following code should typecheck:

export const doc: JSONAPI.Document = { data: null };

Instead, it gives the following error:

Type 'null' is not assignable to type 'PrimaryData<string, AttributesObject<{ [k: string]: Value; }>>'. [2322]

This is because the PrimaryData type, which is used as the type of data in DocWithData is an interface that assumes the value is an existing object.

Is this intentional?

Expected behavior
The above should typecheck, but it gives the indicated error.

System Information (please complete the following information):

  • OS: N/A
  • Browser N/A
  • TypeScript Version 4 (but would apply to all versions)
Lingua principale
TypeScript
Stelle
54
Fork
6
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 mike-north/jsonapi-typescript

Tutte le issue di mike-north/jsonapi-typescript

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.