Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error cases need better documentation, they are rejected Promises #807

Closed
Tracked by #818
ColinEberhardt opened this issue Aug 30, 2022 · 1 comment · Fixed by #843
Closed
Tracked by #818

Error cases need better documentation, they are rejected Promises #807

ColinEberhardt opened this issue Aug 30, 2022 · 1 comment · Fixed by #843
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@ColinEberhardt
Copy link
Contributor

In a number of instance, API methods are described as returning errors with a given error string.

For example, the description for open is as follows:

If opening errors, it returns an Error with a string from the OpenError enumeration.

The open method returns a Promise, as a result, it doesn't return an error, instead, the Promise is rejected with a resultant value.

Notably, a few container implementations don't reject Error types, instead they reject with the resultant string value.

@ColinEberhardt ColinEberhardt added the bug Something isn't working label Aug 30, 2022
@ColinEberhardt
Copy link
Contributor Author

See also: finos/FDC3-conformance-framework#53

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants