Leahnaya/nxapi
1
0
Fork 0
mirror of https://github.com/samuelthomas2774/nxapi.git synced 2026-08-19 17:16:48 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add function to update user agent from package.json

Browse Source
This commit is contained in:
Samuel Elliott
2023-03-25 23:02:32 +00:00
parent 2da7f4f66e
commit bb093d6b22
4 changed files with 80 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/lib/index.md
View File

@@ -151,6 +151,10 @@ try {
This function is used to set the user agent string to use for non-Nintendo API requests. Any project using nxapi (including as a dependency of another project) must call this function with an appropriate user agent string segment. See [user agent strings](../../README.md#user-agent-strings).
#### `addUserAgentFromPackageJson`
This function is used to set the user agent string to use for non-Nintendo API requests using data from a package.json file. A string, URL object or the package.json data can be provided, as well as optional additional data. If a string/URL is provided this will return a Promise that will be resolved once the user agent is updated. See [user agent strings](../../README.md#user-agent-strings).
#### `version`
nxapi's version number.