fix typescript definitions

appwrite · Jun 3, 2021 · 6782a59 · 6782a59
1 parent 302dd45
commit 6782a59
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 113 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -304,9 +304,9 @@ declare module "node-appwrite" {
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getBrowser(code: string, width?: number, height?: number, quality?: number): string;
+    getBrowser(code: string, width?: number, height?: number, quality?: number): Promise<Buffer>;
 
     /**
      * Get Credit Card Icon
@@ -320,9 +320,9 @@ declare module "node-appwrite" {
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getCreditCard(code: string, width?: number, height?: number, quality?: number): string;
+    getCreditCard(code: string, width?: number, height?: number, quality?: number): Promise<Buffer>;
 
     /**
      * Get Favicon
@@ -333,9 +333,9 @@ declare module "node-appwrite" {
      *
      * @param {string} url
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getFavicon(url: string): string;
+    getFavicon(url: string): Promise<Buffer>;
 
     /**
      * Get Country Flag
@@ -349,9 +349,9 @@ declare module "node-appwrite" {
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getFlag(code: string, width?: number, height?: number, quality?: number): string;
+    getFlag(code: string, width?: number, height?: number, quality?: number): Promise<Buffer>;
 
     /**
      * Get Image from URL
@@ -365,9 +365,9 @@ declare module "node-appwrite" {
      * @param {number} width
      * @param {number} height
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getImage(url: string, width?: number, height?: number): string;
+    getImage(url: string, width?: number, height?: number): Promise<Buffer>;
 
     /**
      * Get User Initials
@@ -389,9 +389,9 @@ declare module "node-appwrite" {
      * @param {string} color
      * @param {string} background
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getInitials(name?: string, width?: number, height?: number, color?: string, background?: string): string;
+    getInitials(name?: string, width?: number, height?: number, color?: string, background?: string): Promise<Buffer>;
 
     /**
      * Get QR Code
@@ -404,9 +404,9 @@ declare module "node-appwrite" {
      * @param {number} margin
      * @param {boolean} download
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getQR(text: string, size?: number, margin?: number, download?: boolean): string;
+    getQR(text: string, size?: number, margin?: number, download?: boolean): Promise<Buffer>;
   }
   export class Database extends Service {
 
@@ -1057,9 +1057,9 @@ declare module "node-appwrite" {
      *
      * @param {string} fileId
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getFileDownload(fileId: string): string;
+    getFileDownload(fileId: string): Promise<Buffer>;
 
     /**
      * Get File Preview
@@ -1081,9 +1081,9 @@ declare module "node-appwrite" {
      * @param {string} background
      * @param {string} output
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getFilePreview(fileId: string, width?: number, height?: number, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): string;
+    getFilePreview(fileId: string, width?: number, height?: number, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): Promise<Buffer>;
 
     /**
      * Get File for View
@@ -1094,9 +1094,9 @@ declare module "node-appwrite" {
      *
      * @param {string} fileId
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise}
      */
-    getFileView(fileId: string): string;
+    getFileView(fileId: string): Promise<Buffer>;
   }
   export class Teams extends Service {
 

diff --git a/lib/services/account.js b/lib/services/account.js
@@ -10,7 +10,6 @@ class Account extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async get() {
         let path = '/account';
@@ -32,7 +31,6 @@ class Account extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async delete() {
         let path = '/account';
@@ -57,7 +55,6 @@ class Account extends Service {
      * @param {string} password
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async updateEmail(email, password) {
         if (typeof email === 'undefined') {
@@ -92,7 +89,6 @@ class Account extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getLogs() {
         let path = '/account/logs';
@@ -111,7 +107,6 @@ class Account extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async updateName(name) {
         if (typeof name === 'undefined') {
@@ -141,7 +136,6 @@ class Account extends Service {
      * @param {string} oldPassword
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async updatePassword(password, oldPassword) {
         if (typeof password === 'undefined') {
@@ -171,7 +165,6 @@ class Account extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getPrefs() {
         let path = '/account/prefs';
@@ -191,7 +184,6 @@ class Account extends Service {
      * @param {object} prefs
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async updatePrefs(prefs) {
         if (typeof prefs === 'undefined') {
@@ -226,7 +218,6 @@ class Account extends Service {
      * @param {string} url
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async createRecovery(email, url) {
         if (typeof email === 'undefined') {
@@ -272,7 +263,6 @@ class Account extends Service {
      * @param {string} passwordAgain
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async updateRecovery(userId, secret, password, passwordAgain) {
         if (typeof userId === 'undefined') {
@@ -323,7 +313,6 @@ class Account extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getSessions() {
         let path = '/account/sessions';
@@ -342,7 +331,6 @@ class Account extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async deleteSessions() {
         let path = '/account/sessions';
@@ -363,7 +351,6 @@ class Account extends Service {
      * @param {string} sessionId
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async deleteSession(sessionId) {
         if (typeof sessionId === 'undefined') {
@@ -400,7 +387,6 @@ class Account extends Service {
      * @param {string} url
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async createVerification(url) {
         if (typeof url === 'undefined') {
@@ -431,7 +417,6 @@ class Account extends Service {
      * @param {string} secret
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async updateVerification(userId, secret) {
         if (typeof userId === 'undefined') {

diff --git a/lib/services/avatars.js b/lib/services/avatars.js
@@ -17,7 +17,6 @@ class Avatars extends Service {
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getBrowser(code, width, height, quality) {
         if (typeof code === 'undefined') {
@@ -57,7 +56,6 @@ class Avatars extends Service {
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getCreditCard(code, width, height, quality) {
         if (typeof code === 'undefined') {
@@ -94,7 +92,6 @@ class Avatars extends Service {
      * @param {string} url
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getFavicon(url) {
         if (typeof url === 'undefined') {
@@ -126,7 +123,6 @@ class Avatars extends Service {
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getFlag(code, width, height, quality) {
         if (typeof code === 'undefined') {
@@ -166,7 +162,6 @@ class Avatars extends Service {
      * @param {number} height
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getImage(url, width, height) {
         if (typeof url === 'undefined') {
@@ -214,7 +209,6 @@ class Avatars extends Service {
      * @param {string} background
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getInitials(name, width, height, color, background) {
         let path = '/avatars/initials';
@@ -257,7 +251,6 @@ class Avatars extends Service {
      * @param {boolean} download
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getQR(text, size, margin, download) {
         if (typeof text === 'undefined') {

diff --git a/lib/services/database.js b/lib/services/database.js
@@ -17,7 +17,6 @@ class Database extends Service {
      * @param {string} orderType
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async listCollections(search, limit, offset, orderType) {
         let path = '/database/collections';
@@ -55,7 +54,6 @@ class Database extends Service {
      * @param {string[]} rules
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async createCollection(name, read, write, rules) {
         if (typeof name === 'undefined') {
@@ -107,7 +105,6 @@ class Database extends Service {
      * @param {string} collectionId
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getCollection(collectionId) {
         if (typeof collectionId === 'undefined') {
@@ -134,7 +131,6 @@ class Database extends Service {
      * @param {string[]} rules
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async updateCollection(collectionId, name, read, write, rules) {
         if (typeof collectionId === 'undefined') {
@@ -178,7 +174,6 @@ class Database extends Service {
      * @param {string} collectionId
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async deleteCollection(collectionId) {
         if (typeof collectionId === 'undefined') {
@@ -211,7 +206,6 @@ class Database extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async listDocuments(collectionId, filters, limit, offset, orderField, orderType, orderCast, search) {
         if (typeof collectionId === 'undefined') {
@@ -271,7 +265,6 @@ class Database extends Service {
      * @param {string} parentPropertyType
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async createDocument(collectionId, data, read, write, parentDocument, parentProperty, parentPropertyType) {
         if (typeof collectionId === 'undefined') {
@@ -324,7 +317,6 @@ class Database extends Service {
      * @param {string} documentId
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async getDocument(collectionId, documentId) {
         if (typeof collectionId === 'undefined') {
@@ -356,7 +348,6 @@ class Database extends Service {
      * @param {string[]} write
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async updateDocument(collectionId, documentId, data, read, write) {
         if (typeof collectionId === 'undefined') {
@@ -402,7 +393,6 @@ class Database extends Service {
      * @param {string} documentId
      * @throws {AppwriteException}
      * @returns {Promise}
-
      */
     async deleteDocument(collectionId, documentId) {
         if (typeof collectionId === 'undefined') {