guildwars2-ts 1.0.1

package/LICENSE

@@ -0,0 +1,16 @@
+ISC License
+
+Copyright (c) 2022 Ivan Sosnov
+Copyright (c) 2021 Julio Sansossio (parts of request base code)
+ 
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# Typescript API Wrapper for Guild Wars 2
+
+## Plans
+- Conditional type validation for several endpoints
+- Data caching for repeated requests
+- Better logging
+- Support for different schemas, when available
+
+## Available Endpoints (Guild Wars 2)
+
+Full support of all endpoints listed in the [API:2 Wiki](https://wiki.guildwars2.com/wiki/API:2) page
+
+
+## Request Example
+
+```typescript
+import { GW2Api, ApiLanguage } from "guildwars2-ts";
+
+const api: GW2Api = new GW2Api({
+	// Token is not required for all of the endpoints
+	token: "YOUR-TOKEN-HERE",
+	language: ApiLanguage.English,
+	rateLimit: {
+		retry: true,
+		attempts: 3,
+	},
+});
+
+(async () => {
+	// Obtain names of all characters on the account
+	await api.account.get().then(console.log);
+	// Obtain details about each of them
+	await api.characters.get().then((characters) => {
+		characters.forEach(async (character) => {
+			await api.characters.getCore(character).then(console.log);
+		});
+	});
+})();
+```