search

nulab / backlog-js

Backlog API version 2 client for browser and node.
https://developer.nulab-inc.com/docs/backlog/
33 stars 13 forks source link

Add deprecated annotation for Deprecated API #29

Closed odanado closed 3 years ago

odanado commented 3 years ago

TypeScript 4.0 and later versions show strikethrough when @deprecated is written in a JSDoc comment.

ref: https://devblogs.microsoft.com/typescript/announcing-typescript-4-0/#deprecated-support

This is useful to inform developers that some APIs, such as https://developer.nulab.com/docs/backlog/api/2/get-list-of-groups/#, are deprecated.

mmktomato commented 3 years ago

I added @deprecated annotations to some methods. This will ship in next release. Thank you for your report!