Leahnaya/nxapi
1
0
Fork 0
mirror of https://github.com/samuelthomas2774/nxapi.git synced 2026-08-25 03:55:33 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Samuel Elliott
2022-10-28 01:13:26 +01:00
parent 6f9afb041d
commit 82ba22b42f
3 changed files with 102 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/lib/nooklink.md
View File

@@ -1,7 +1,7 @@
`nxapi/nooklink`
---
NookLink is more complex that SplatNet 2 as it supports multiple users linked to the same network account.
NookLink is more complex than other web services as it supports multiple users linked to the same network account:
- `NooklinkApi` is used at NSA-level, and is solely used to list available NookLink users and authenticate to NookLink at ACNH-level.
- `NooklinkUserApi` is used at ACNH-level, and is used to perform all other actions in the NookLink web app.

2
docs/lib/splatnet3.md
View File

@@ -120,4 +120,4 @@ splatnet.onTokenShouldRenew = async (remaining: number, response: Response) => {
### API types
`nxapi/splatnet3` exports all API types from [src/api/splatnet3-types.ts](../../src/api/splatnet3-types.ts).
SplatNet 3 types are available from [splatnet3-types](https://gitlab.fancy.org.uk/samuel/splatnet3-types) ([GitHub](https://github.com/nintendoapis/splatnet3-types)).