XOR is expressible in TypeScript
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
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
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de mike-north/jsonapi-typescript
-
Dependency DashboardAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 15/100
mike-north/jsonapi-typescript#246 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
mike-north/jsonapi-typescript#197 · 1 reacción ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
mike-north/jsonapi-typescript#180 · 2 reacciones ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 58/100
mike-north/jsonapi-typescript#134 ·
-
Interested in validators?Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
mike-north/jsonapi-typescript#128 · 3 comentarios ·
Todos los issues de mike-north/jsonapi-typescript
Issues similares
-
Stop retrying permanent GitHub API failures in retry.shPosiblemente ocupada @muspi-merol-review la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
promplate/code-review#113 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
ix-toast (5.3): the status icon has `role="img"` and no accessible name (axe `role-img-alt`)Abiertotriage
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día
-
サムネイルの Storage のバケット(`thumbnails`)に、大きさの上限(1 MiB)と許可する種類(JPEG、PNG、WebP)を設定するPosiblemente ocupada @ykzts la tomó hoy. Abiertotech: supabase
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
inabagumi/shinju-date#7147 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
elecnix/your-attention#129 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
umami-software/umami#4780 ·
Los mantenedores suelen responder en 3 días