errors icon indicating copy to clipboard operation
errors copied to clipboard

Docs for isError()

Open stephen-last opened this issue 9 years ago • 2 comments

There is an exported method called isError(): https://github.com/bodenr/errors/blob/master/lib/errors.js#L112

This should be added to the docs as it's very useful for differentiating between errors created by this module and other errors.

See http://stackoverflow.com/questions/37070083/error-objects-native-and-custom-how-to-tell-the-difference.

stephen-last avatar May 06 '16 11:05 stephen-last

Are you suggesting isError() should be added to the Readme?

Technically the Readme is not the API docs, but rather an overview of the main features of the module. In the source, the method is documented and to the best of my knowledge should compile into the API docs if you build them https://github.com/bodenr/errors#api-docs

bodenr avatar May 13 '16 10:05 bodenr

Thanks @bodenr

Technically you're correct of course, it's just a lot of people include the API docs in the root README.md file.

I can see isError() now: https://github.com/bodenr/errors/blob/master/doc/md/errors.md#iserrorerr

Was that there 26 days ago when I posted this issue, or have you updated it..?

stephen-last avatar Jun 01 '16 15:06 stephen-last