Skip to content

[Bug] KintoneRestAPIErrorのドキュメントに「errors」オブジェクトが載っていない #42

@the-red

Description

@the-red

概要

https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/errorHandling.md#kintonerestapierror
公式ドキュメントでは、KintoneRestAPIErrorのプロパティ内でエラーの手がかりになりそうなのは
messageくらいしかありません。
しかし実際にはerrorsというオブジェクトがあって、
この中にはエラーの詳細がかなり詳しく入っています。

エラーハンドリングの際にはいつもこのKintoneRestAPIError#errorsを使うのですが、
なぜドキュメントにはerrorsオブジェクトが明記されてないのでしょうか?
これがないとまともなエラーハンドリングができないので、ぜひドキュメントで言及してください。
ドキュメントに書いてある情報だけでエラーハンドリングしようとすると、
APIを生で叩くほうがマシになってしまいます。
よろしくお願いします。

対象パッケージ

@kintone/rest-api-client

対象バージョン

5.0

再現手順

https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/errorHandling.md#kintonerestapierror
このドキュメントを読む

期待する挙動

ドキュメント内にKintoneRestAPIError#errorsについての詳細が載っている状態

実際の挙動

ドキュメント内にKintoneRestAPIErrorについて触れられていない

環境

環境問わず

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions