XOR is expressible in TypeScript

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

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia individuando le definizioni di Document, DocWithData e DocWithErrors, quindi riproduci l’assegnazione mostrata e rivedi i tipi XOR proposti. Conferma il trattamento previsto di meta opzionale; il lavoro è completo quando i documenti contenenti sia errors sia data vengono rifiutati, mentre i documenti validi di data o error, incluso meta, continuano a essere accettati.

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

Descrizione

enhancement

Describe the bug

// The members data and errors MUST NOT coexist in the same document.
// ⛔️ NOT EXPRESSIBLE IN TYPESCRIPT
// If a document does not contain a top-level data key,
//    the included member MUST NOT be present either.
// ⛔️ NOT EXPRESSIBLE IN TYPESCRIPT

is not true any longer

To Reproduce

const foo: Document = {
  errors: [{
    status: 200
  }],
  data: {
    type: 'foo',
    id: '123',
    attributes: {
      foo: 'bar',
      baz: 'biz'
    }
  },
  included: [],
  meta: {
    foo: 'bar'
  }
}

is valid and should not be

Additional context

type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;

interface DocWithDataAndOptionalMeta extends DocWithData{
  meta?: object;
}
interface DocWithErrorsAndOptionalMeta extends DocWithErrors {
  meta?: object;
}

type JSONAPIDocument = XOR<DocWithErrorsAndOptionalMeta, DocWithDataAndOptionalMeta>;

I believe gets you what we want. I can open a PR, was just not certain about how to handle meta. It seems fine to have meta included in a top level response w/errors present or with a 'normal' doc

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.