npm - node-appwrite - Versions diffs - 12.0.0-rc.4 → 12.0.0 - Mend

node-appwrite 12.0.0-rc.4 → 12.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (278) hide show

package/docs/examples/databases/create-email-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.createEmailAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.createEmailAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     'email@example.com', // default (optional)

package/docs/examples/databases/create-enum-attribute.md CHANGED Viewed

@@ -7,12 +7,12 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.createEnumAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.createEnumAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     [], // elements
     false, // required
-    '[DEFAULT]', // default (optional)
+    '<DEFAULT>', // default (optional)
     false // array (optional)
 );

package/docs/examples/databases/create-float-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.createFloatAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.createFloatAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     null, // min (optional)

package/docs/examples/databases/create-index.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.createIndex(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.createIndex(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     sdk.IndexType.Key, // type
     [], // attributes

package/docs/examples/databases/create-integer-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.createIntegerAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.createIntegerAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     null, // min (optional)

package/docs/examples/databases/create-ip-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.createIpAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.createIpAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     '', // default (optional)

package/docs/examples/databases/create-relationship-attribute.md CHANGED Viewed

@@ -7,10 +7,10 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.createRelationshipAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
-    '[RELATED_COLLECTION_ID]', // relatedCollectionId
+const result = await databases.createRelationshipAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<RELATED_COLLECTION_ID>', // relatedCollectionId
     sdk.RelationshipType.OneToOne, // type
     false, // twoWay (optional)
     '', // key (optional)

package/docs/examples/databases/create-string-attribute.md CHANGED Viewed

@@ -7,13 +7,13 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.createStringAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.createStringAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     1, // size
     false, // required
-    '[DEFAULT]', // default (optional)
+    '<DEFAULT>', // default (optional)
     false, // array (optional)
     false // encrypt (optional)
 );

package/docs/examples/databases/create-url-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.createUrlAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.createUrlAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     'https://example.com', // default (optional)

package/docs/examples/databases/create.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.create(
-    '[DATABASE_ID]', // databaseId
-    '[NAME]', // name
+const result = await databases.create(
+    '<DATABASE_ID>', // databaseId
+    '<NAME>', // name
     false // enabled (optional)
 );

package/docs/examples/databases/delete-attribute.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.deleteAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.deleteAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '' // key
 );

package/docs/examples/databases/delete-collection.md CHANGED Viewed

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.deleteCollection(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]' // collectionId
+const result = await databases.deleteCollection(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>' // collectionId
 );

package/docs/examples/databases/delete-document.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.deleteDocument(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
-    '[DOCUMENT_ID]' // documentId
+const result = await databases.deleteDocument(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<DOCUMENT_ID>' // documentId
 );

package/docs/examples/databases/delete-index.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.deleteIndex(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.deleteIndex(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '' // key
 );

package/docs/examples/databases/delete.md CHANGED Viewed

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.delete(
-    '[DATABASE_ID]' // databaseId
+const result = await databases.delete(
+    '<DATABASE_ID>' // databaseId
 );

package/docs/examples/databases/get-attribute.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.getAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.getAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '' // key
 );

package/docs/examples/databases/get-collection.md CHANGED Viewed

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.getCollection(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]' // collectionId
+const result = await databases.getCollection(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>' // collectionId
 );

package/docs/examples/databases/get-document.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.getDocument(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
-    '[DOCUMENT_ID]', // documentId
+const result = await databases.getDocument(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<DOCUMENT_ID>', // documentId
     [] // queries (optional)
 );

package/docs/examples/databases/get-index.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.getIndex(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.getIndex(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '' // key
 );

package/docs/examples/databases/get.md CHANGED Viewed

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.get(
-    '[DATABASE_ID]' // databaseId
+const result = await databases.get(
+    '<DATABASE_ID>' // databaseId
 );

package/docs/examples/databases/list-attributes.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.listAttributes(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.listAttributes(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     [] // queries (optional)
 );

package/docs/examples/databases/list-collections.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.listCollections(
-    '[DATABASE_ID]', // databaseId
+const result = await databases.listCollections(
+    '<DATABASE_ID>', // databaseId
     [], // queries (optional)
-    '[SEARCH]' // search (optional)
+    '<SEARCH>' // search (optional)
 );

package/docs/examples/databases/list-documents.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.listDocuments(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.listDocuments(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     [] // queries (optional)
 );

package/docs/examples/databases/list-indexes.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.listIndexes(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.listIndexes(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     [] // queries (optional)
 );

package/docs/examples/databases/list.md CHANGED Viewed

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.list(
+const result = await databases.list(
     [], // queries (optional)
-    '[SEARCH]' // search (optional)
+    '<SEARCH>' // search (optional)
 );

package/docs/examples/databases/update-boolean-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateBooleanAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateBooleanAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     false // default

package/docs/examples/databases/update-collection.md CHANGED Viewed

@@ -7,10 +7,10 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateCollection(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
-    '[NAME]', // name
+const result = await databases.updateCollection(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<NAME>', // name
     ["read("any")"], // permissions (optional)
     false, // documentSecurity (optional)
     false // enabled (optional)

package/docs/examples/databases/update-datetime-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateDatetimeAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateDatetimeAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     '' // default

package/docs/examples/databases/update-document.md CHANGED Viewed

@@ -7,10 +7,10 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateDocument(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
-    '[DOCUMENT_ID]', // documentId
+const result = await databases.updateDocument(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<DOCUMENT_ID>', // documentId
     {}, // data (optional)
     ["read("any")"] // permissions (optional)
 );

package/docs/examples/databases/update-email-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateEmailAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateEmailAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     'email@example.com' // default

package/docs/examples/databases/update-enum-attribute.md CHANGED Viewed

@@ -7,11 +7,11 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateEnumAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateEnumAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     [], // elements
     false, // required
-    '[DEFAULT]' // default
+    '<DEFAULT>' // default
 );

package/docs/examples/databases/update-float-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateFloatAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateFloatAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     null, // min

package/docs/examples/databases/update-integer-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateIntegerAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateIntegerAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     null, // min

package/docs/examples/databases/update-ip-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateIpAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateIpAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     '' // default

package/docs/examples/databases/update-relationship-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateRelationshipAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateRelationshipAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     sdk.RelationMutate.Cascade // onDelete (optional)
 );

package/docs/examples/databases/update-string-attribute.md CHANGED Viewed

@@ -7,10 +7,10 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateStringAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateStringAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
-    '[DEFAULT]' // default
+    '<DEFAULT>' // default
 );

package/docs/examples/databases/update-url-attribute.md CHANGED Viewed

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.updateUrlAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+const result = await databases.updateUrlAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     'https://example.com' // default

package/docs/examples/databases/update.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const databases = new sdk.Databases(client);
-const response = await databases.update(
-    '[DATABASE_ID]', // databaseId
-    '[NAME]', // name
+const result = await databases.update(
+    '<DATABASE_ID>', // databaseId
+    '<NAME>', // name
     false // enabled (optional)
 );

package/docs/examples/functions/create-build.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const functions = new sdk.Functions(client);
-const response = await functions.createBuild(
-    '[FUNCTION_ID]', // functionId
-    '[DEPLOYMENT_ID]', // deploymentId
-    '[BUILD_ID]' // buildId
+const result = await functions.createBuild(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>', // deploymentId
+    '<BUILD_ID>' // buildId
 );

package/docs/examples/functions/create-deployment.md CHANGED Viewed

@@ -8,10 +8,10 @@ const client = new sdk.Client()
 const functions = new sdk.Functions(client);
-const response = await functions.createDeployment(
-    '[FUNCTION_ID]', // functionId
+const result = await functions.createDeployment(
+    '<FUNCTION_ID>', // functionId
     InputFile.fromPath('/path/to/file.png', 'file.png'), // code
     false, // activate
-    '[ENTRYPOINT]', // entrypoint (optional)
-    '[COMMANDS]' // commands (optional)
+    '<ENTRYPOINT>', // entrypoint (optional)
+    '<COMMANDS>' // commands (optional)
 );

package/docs/examples/functions/create-execution.md CHANGED Viewed

@@ -7,11 +7,11 @@ const client = new sdk.Client()
 const functions = new sdk.Functions(client);
-const response = await functions.createExecution(
-    '[FUNCTION_ID]', // functionId
-    '[BODY]', // body (optional)
+const result = await functions.createExecution(
+    '<FUNCTION_ID>', // functionId
+    '<BODY>', // body (optional)
     false, // async (optional)
-    '[PATH]', // path (optional)
+    '<PATH>', // path (optional)
     sdk.ExecutionMethod.GET, // method (optional)
     {} // headers (optional)
 );

package/docs/examples/functions/create-variable.md CHANGED Viewed

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 const functions = new sdk.Functions(client);
-const response = await functions.createVariable(
-    '[FUNCTION_ID]', // functionId
-    '[KEY]', // key
-    '[VALUE]' // value
+const result = await functions.createVariable(
+    '<FUNCTION_ID>', // functionId
+    '<KEY>', // key
+    '<VALUE>' // value
 );