XOR is expressible in TypeScript

Abierto
#24 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
typescript
Área
api

Línea de trabajo

Comienza localizando las definiciones de Document, DocWithData y DocWithErrors; después, reproduce la asignación mostrada y revisa los tipos XOR propuestos. Confirma el tratamiento previsto de meta opcional; la tarea está terminada cuando se rechazan los documentos que contienen tanto errors como data, mientras que los documentos válidos de data o error, incluido meta, siguen siendo aceptados.

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

Descripción

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

Lenguaje dominante
TypeScript
Estrellas
54
Forks
6
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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

Todos los issues de mike-north/jsonapi-typescript

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.