XOR is expressible in TypeScript
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- typescript
- 領域
- api
調査の方向性
まず Document、DocWithData、DocWithErrors の定義を見つけ、次に示されている代入を再現して、提案された XOR 型を確認します。オプションの meta の意図された扱いを確認します。完了条件は、errors と data の両方を含むドキュメントが拒否され、meta を含む有効な data または error のドキュメントは引き続き受け入れられることです。
索引モデルが issue の本文から書いたものです。
説明
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
- 主要言語
- TypeScript
- スター
- 54
- フォーク
- 6
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
mike-north/jsonapi-typescript のほかの issue
-
Dependency Dashboardオープン
難易度 4/5 3〜5日 初心者へのやさしさ 15/100
mike-north/jsonapi-typescript#246 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
mike-north/jsonapi-typescript#197 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
mike-north/jsonapi-typescript#180 · リアクション 2 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 58/100
mike-north/jsonapi-typescript#134 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
mike-north/jsonapi-typescript#128 · コメント 3 件 ·
mike-north/jsonapi-typescript の issue をすべて見る
似ている issue
-
ready-for-ai
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
umbraco/Umbraco-CMS-MCP-Dev#647 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
HelloAOLab/seed-bible#2173 ·
メンテナーはふだん 1 日以内に返信
-
enhancement good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
hocinehacherouf/liberarr#77 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
LibreChat-AI/LibreChat#18225 ·
メンテナーはふだん 1 日以内に返信
-
b-ber/build/epub b-ber/themes
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
triplecanopy/b-ber#790 ·
メンテナーはふだん 1 日以内に返信