guildwars2-ts 1.5.0 → 1.6.0

package/LICENSE

@@ -1,7 +1,6 @@
 ISC License
 
-Copyright (c) 2023 Ivan Sosnov
-Copyright (c) 2021 Julio Sansossio (parts of request base code)
+Copyright (c) 2022 Ivan Sosnov
  
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/README.md

@@ -17,14 +17,19 @@ Full support of all endpoints listed in the [API:2 Wiki](https://wiki.guildwars2
 import { GW2Api, ApiLanguage, setLogLevel, LogLevel } from "guildwars2-ts";
 
 const api: GW2Api = new GW2Api({
-	// Token is not required for all of the endpoints
+	// Some endpoints require authentication
 	token: "YOUR-TOKEN-HERE",
 	language: ApiLanguage.English,
+	// Optional, but recommended
 	rateLimitRetry: true
+	// When using guildwars2-ts in a browser, setting this is required to avoid CORS errors. Can be omitted otherwise
+	inBrowser: true
 });
 
 // Set to error by default, so you can set it to info for extra verbosity
 setLogLevel(LogLevel.info); 
+// Set to true by default, but recommended to be turned off, if your log does not render correctly
+enableLogColors(false);
 
 (async () => {
 	// Obtain names of all characters on the account
@@ -35,6 +40,11 @@ setLogLevel(LogLevel.info);
 			await api.characters.getCore(character).then(console.log);
 		});
 	});
+
+	// Types are automatically inferred for any function calls, like shown above
+	// If explicit types are preferred, it can be done as well
+	// Zod@^4 is required for this. In the future, this will be simplified
+	const emblems: z.infer<typeof EmblemDTO> = await api.emblem.get("foregrounds", [1, 2, 3]);
 })();
 ```
 
@@ -44,6 +54,12 @@ If you encounter any kinds of errors, or wish to add/update the functionality pr
 
 Otherwise, please check open [issue reports](https://gitlab.com/dinckelman/guildwars2-ts/-/issues/), to see if there is an existing discussion on the issue, or open a new request. In case of runtime errors, request validation error logs are extremely helpful, so please include them in the report, as guided by the template.
 
+## Planned features
+
+* Request caching (under consideration)
+* Support for pagination
+* Support for different/older schema version
+
 [npm-image]: https://img.shields.io/npm/v/guildwars2-ts
 [npm-link]: https://www.npmjs.com/package/guildwars2-ts
 [license]: https://img.shields.io/gitlab/license/dinckelman%2Fguildwars2-ts