QueryParameter returns URLSearchParams value #11
Conversation
| if (params.explode) { | ||
| return Object.entries(params.value) | ||
| .map(([k, v]) => `${k}=${v}`) | ||
| .join(";"); |
There was a problem hiding this comment.
CookieParameterはURLSearchParams使うの良くなさそうなので旧実装もってきて分離しました。
explode: true の場合の区切り文字は ; の方が適切な気がしたので変更しています。
Coreの方にあった方がよければそちらに移します。
There was a problem hiding this comment.
style: form、explode: true でINPUTがobjectの場合以下の行に該当します。
RFC6570上で特にCookie Parameterについて言及を自分は見つけられませんでした。他にこの変更をサポートする仕様はありますか？
参考
There was a problem hiding this comment.
このPRはQueryParameterだけにフォーカスして、必要になったらCookie Parameterの方も調整しましょう 🙏
src/Core.ts
Outdated
| @@ -36,75 +36,97 @@ export const generateFromSimple = (key: string | number, params: ParameterOfSimp | |||
| return undefined; | |||
| }; | |||
|
|
|||
| export const generateFormParamter = (key: string | number, params: ParameterOfForm): string => { | |||
| export const generateFormParamter = (key: string | number, params: ParameterOfForm): URLSearchParams | undefined => { | |||
There was a problem hiding this comment.
既存の関数で返り値が変更になるような破壊的変更は望みません。
この関数の内部ではstringを返すように変更をお願いします。
URLSearchParamsで返すようなAPIを既存の関数と独立してexportし、ライブラリの利用者がどちらも利用可能な状態にしてください。
他も同様です。
| } | ||
| return undefined; | ||
| }; | ||
|
|
||
| const generateFormParamter = (key: string | number, params: ParameterOfForm): string => { |
There was a problem hiding this comment.
こちらの関数利用したい場合はテストされるようにexportし、テストを実施してください。
| @@ -90,7 +90,7 @@ describe("QueryParameter - style:spaceDelimited", () => { | |||
| style: "spaceDelimited", | |||
| explode: false, | |||
| }); | |||
| expect(result1).toBe("blue%20black%20brown"); | |||
| expect(result1).toBe("color=blue+black+brown"); | |||
There was a problem hiding this comment.
ここはOpenAPI Formatterの仕様と異なるようです。
| @@ -90,7 +90,7 @@ describe("QueryParameter - style:spaceDelimited", () => { | |||
| style: "spaceDelimited", | |||
| explode: false, | |||
| }); | |||
| expect(result1).toBe("blue%20black%20brown"); | |||
| expect(result1).toBe("color=blue+black+brown"); | |||
There was a problem hiding this comment.
expect(result1).toBe("color=blue%20black%20brown");There was a problem hiding this comment.
https://qiita.com/masakielastic/items/61f5d9a215c62b55ccf2
このような違いがあるようです。このライブラリはOpenAPI準拠で表すので%20に寄せます。
| @@ -102,7 +102,7 @@ describe("QueryParameter - style:spaceDelimited", () => { | |||
| style: "spaceDelimited", | |||
| explode: false, | |||
| }); | |||
| expect(result1).toBe("R%20100%20G%20200%20B%20150"); | |||
| expect(result1).toBe("color=R+100+G+200+B+150"); | |||
There was a problem hiding this comment.
expect(result1).toBe("color=R%20100%20G%20200%20B%20150");
|
Merged #12 |
最終的なシリアライズを使う側でコントロールできるようにするために、QueryParameterはstringではなくURLSearchParamsを返すようにしました