chore(website): type getPackage using the API types #1307
Conversation
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 0184f3c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
nicosampler
force-pushed
the
testApiTypes
branch
from
5633f24 to
74429b5
Compare
| const response = await axios.get<{ total: any; data: ApiDocument[] }>(`packages/${name}`, { | ||
| baseURL: externalLinks.API_CANNON, | ||
| }); | ||
| return response.data; |
There was a problem hiding this comment.
Shouldn't this be response.data.data ?
Not sure about the response object, but the API on GET /packages/:packageName responds with:
{
status: number,
total: number,
data: { ... }
}There was a problem hiding this comment.
yes, on line 21 we are defining the shape of the date.
then on line 24, we return response.data which will be {total: any; data: ApiDocument}. If we return response.data.data we will be removing the total prop which might be useful in the future.
I just realized that total should be of type number, not any.
There was a problem hiding this comment.
Ah perfect, just wanted to make sure that it is being used correctly on the Components
nicosampler
changed the title
This PR adds types to the getPackage method that brings packages by name or full ref.
All the logic was moved to two new hooks.