Merge pull request #32 from cloudnode-pro/31-add-throws-definitions-for-new-page-methods

Add missing throws definitions

Author: williamd5

README.md

@@ -129,7 +129,7 @@ Get another page of paginated results
  - `response` <code>[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.PaginatedData](#interface-cloudnodepaginateddatat)&lt;T>></code> Response to get a different page of.
  - `page` <code>[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)</code> Page to get.
  - Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.PaginatedData](#interface-cloudnodepaginateddatat)&lt;T>> | [null](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/null)></code> The new page or null if the page is out of bounds
-
+ - Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror)</code> Error returned by the API
 
 <a name="cloudnodegetnextpagetresponse"></a>
 
@@ -139,7 +139,7 @@ Get next page of paginated results
 
  - `response` <code>[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.PaginatedData](#interface-cloudnodepaginateddatat)&lt;T>></code> Response to get the next page of.
  - Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.PaginatedData](#interface-cloudnodepaginateddatat)&lt;T>> | [null](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/null)></code> The next page or null if this is the last page
-
+ - Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror)</code> Error returned by the API
 
 <a name="cloudnodegetpreviouspagetresponse"></a>
 
@@ -149,7 +149,7 @@ Get previous page of paginated results
 
  - `response` <code>[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.PaginatedData](#interface-cloudnodepaginateddatat)&lt;T>></code> Response to get the previous page of.
  - Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.PaginatedData](#interface-cloudnodepaginateddatat)&lt;T>> | [null](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/null)></code> The previous page or null if this is the first page
-
+ - Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror)</code> Error returned by the API
 
 <a name="cloudnodegetallpagestresponse"></a>
 
@@ -160,7 +160,7 @@ Get all other pages of paginated results and return the complete data
 
  - `response` <code>[Cloudnode.ApiResponse](#class-cloudnodeapiresponset)&lt;[Cloudnode.PaginatedData](#interface-cloudnodepaginateddatat)&lt;T>></code> Response to get all pages of.
  - Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.PaginatedData](#interface-cloudnodepaginateddatat)&lt;T>></code> All of the data in 1 page
-
+ - Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror)</code> Error returned by the API
 
 <a name="cloudnodenewslettergetid"></a>
 

browser/Cloudnode.js

@@ -84,6 +84,7 @@ class Cloudnode {
      * @param response Response to get a different page of
      * @param page Page to get
      * @returns The new page or null if the page is out of bounds
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getPage(response, page) {
         if (page * response.limit > response.total || page < 1)
@@ -96,6 +97,7 @@ class Cloudnode {
      * Get next page of paginated results
      * @param response Response to get the next page of
      * @returns The next page or null if this is the last page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getNextPage(response) {
         return await this.getPage(response, response.page + 1);
@@ -104,6 +106,7 @@ class Cloudnode {
      * Get previous page of paginated results
      * @param response Response to get the previous page of
      * @returns The previous page or null if this is the first page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getPreviousPage(response) {
         return await this.getPage(response, response.page - 1);
@@ -113,6 +116,7 @@ class Cloudnode {
      * > **Warning:** Depending on the amount of data, this can take a long time and use a lot of memory.
      * @param response Response to get all pages of
      * @returns All of the data in 1 page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getAllPages(response) {
         const pages = new Array(Math.ceil(response.total / response.limit)).fill(null);

gen/docs.ts

@@ -77,25 +77,25 @@ export function generateDocSchema (schema: Schema, config: Config, pkg: Package)
     ], {
         type: `Promise<${config.name}.ApiResponse<${config.name}.PaginatedData<T>> | null>`,
         description: "The new page or null if the page is out of bounds"
-    }, []));
+    }, [{type: `${config.name}.Error`, description: "Error returned by the API"}]));
     always.push(new DocSchema.Method(`${config.name}.getNextPage<T>`, "Get next page of paginated results", [
         new DocSchema.Parameter("response", `${config.name}.ApiResponse<${config.name}.PaginatedData<T>>`, "Response to get the next page of", true)
     ], {
         type: `Promise<${config.name}.ApiResponse<${config.name}.PaginatedData<T>> | null>`,
         description: "The next page or null if this is the last page"
-    }, []));
+    }, [{type: `${config.name}.Error`, description: "Error returned by the API"}]));
     always.push(new DocSchema.Method(`${config.name}.getPreviousPage<T>`, "Get previous page of paginated results", [
         new DocSchema.Parameter("response", `${config.name}.ApiResponse<${config.name}.PaginatedData<T>>`, "Response to get the previous page of", true)
     ], {
         type: `Promise<${config.name}.ApiResponse<${config.name}.PaginatedData<T>> | null>`,
         description: "The previous page or null if this is the first page"
-    }, []));
+    }, [{type: `${config.name}.Error`, description: "Error returned by the API"}]));
     always.push(new DocSchema.Method(`${config.name}.getAllPages<T>`, "Get all other pages of paginated results and return the complete data\n> **Warning:** Depending on the amount of data, this can take a long time and use a lot of memory.", [
         new DocSchema.Parameter("response", `${config.name}.ApiResponse<${config.name}.PaginatedData<T>>`, "Response to get all pages of", true)
     ], {
         type: `Promise<${config.name}.PaginatedData<T>>`,
         description: "All of the data in 1 page"
-    }, []));
+    }, [{type: `${config.name}.Error`, description: "Error returned by the API"}]));
     mainClass.properties.unshift(...always);
     mainNamespace.properties.sort((a, b) => a.displayName.localeCompare(b.displayName));
 

gen/templates/main.mustache

@@ -86,6 +86,7 @@ class {{config.name}} {
      * @param response Response to get a different page of
      * @param page Page to get
      * @returns The new page or null if the page is out of bounds
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getPage<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>, page: number): Promise<Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>> | null> {
         if (page * response.limit > response.total || page < 1) return null;
@@ -98,6 +99,7 @@ class {{config.name}} {
      * Get next page of paginated results
      * @param response Response to get the next page of
      * @returns The next page or null if this is the last page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getNextPage<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>): Promise<Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>> | null> {
         return await this.getPage(response, response.page + 1);
@@ -107,6 +109,7 @@ class {{config.name}} {
      * Get previous page of paginated results
      * @param response Response to get the previous page of
      * @returns The previous page or null if this is the first page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getPreviousPage<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>): Promise<Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>> | null> {
         return await this.getPage(response, response.page - 1);
@@ -117,6 +120,7 @@ class {{config.name}} {
      * > **Warning:** Depending on the amount of data, this can take a long time and use a lot of memory.
      * @param response Response to get all pages of
      * @returns All of the data in 1 page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getAllPages<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>): Promise<Cloudnode.PaginatedData<T>> {
         const pages: (true | null)[] = new Array(Math.ceil(response.total / response.limit)).fill(null);

src/Cloudnode.d.ts

@@ -16,25 +16,29 @@ declare class Cloudnode {
      * @param response Response to get a different page of
      * @param page Page to get
      * @returns The new page or null if the page is out of bounds
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     getPage<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>, page: number): Promise<Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>> | null>;
     /**
      * Get next page of paginated results
      * @param response Response to get the next page of
      * @returns The next page or null if this is the last page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     getNextPage<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>): Promise<Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>> | null>;
     /**
      * Get previous page of paginated results
      * @param response Response to get the previous page of
      * @returns The previous page or null if this is the first page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     getPreviousPage<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>): Promise<Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>> | null>;
     /**
      * Get all other pages of paginated results and return the complete data
      * > **Warning:** Depending on the amount of data, this can take a long time and use a lot of memory.
      * @param response Response to get all pages of
      * @returns All of the data in 1 page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     getAllPages<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>): Promise<Cloudnode.PaginatedData<T>>;
     newsletter: {

src/Cloudnode.js

@@ -84,6 +84,7 @@ class Cloudnode {
      * @param response Response to get a different page of
      * @param page Page to get
      * @returns The new page or null if the page is out of bounds
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getPage(response, page) {
         if (page * response.limit > response.total || page < 1)
@@ -96,6 +97,7 @@ class Cloudnode {
      * Get next page of paginated results
      * @param response Response to get the next page of
      * @returns The next page or null if this is the last page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getNextPage(response) {
         return await this.getPage(response, response.page + 1);
@@ -104,6 +106,7 @@ class Cloudnode {
      * Get previous page of paginated results
      * @param response Response to get the previous page of
      * @returns The previous page or null if this is the first page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getPreviousPage(response) {
         return await this.getPage(response, response.page - 1);
@@ -113,6 +116,7 @@ class Cloudnode {
      * > **Warning:** Depending on the amount of data, this can take a long time and use a lot of memory.
      * @param response Response to get all pages of
      * @returns All of the data in 1 page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getAllPages(response) {
         const pages = new Array(Math.ceil(response.total / response.limit)).fill(null);

src/Cloudnode.ts

@@ -86,6 +86,7 @@ class Cloudnode {
      * @param response Response to get a different page of
      * @param page Page to get
      * @returns The new page or null if the page is out of bounds
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getPage<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>, page: number): Promise<Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>> | null> {
         if (page * response.limit > response.total || page < 1) return null;
@@ -98,6 +99,7 @@ class Cloudnode {
      * Get next page of paginated results
      * @param response Response to get the next page of
      * @returns The next page or null if this is the last page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getNextPage<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>): Promise<Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>> | null> {
         return await this.getPage(response, response.page + 1);
@@ -107,6 +109,7 @@ class Cloudnode {
      * Get previous page of paginated results
      * @param response Response to get the previous page of
      * @returns The previous page or null if this is the first page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getPreviousPage<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>): Promise<Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>> | null> {
         return await this.getPage(response, response.page - 1);
@@ -117,6 +120,7 @@ class Cloudnode {
      * > **Warning:** Depending on the amount of data, this can take a long time and use a lot of memory.
      * @param response Response to get all pages of
      * @returns All of the data in 1 page
+     * @throws {Cloudnode.Error} Error returned by the API
      */
     async getAllPages<T>(response: Cloudnode.ApiResponse<Cloudnode.PaginatedData<T>>): Promise<Cloudnode.PaginatedData<T>> {
         const pages: (true | null)[] = new Array(Math.ceil(response.total / response.limit)).fill(null);