⚠️ DEPRECATED: This SDK is deprecated. Please use the Appwrite Node.js SDK with Deno instead.

This Deno-specific SDK is now deprecated. Thanks to Deno’s excellent Node.js compatibility, you can now use the official Appwrite Node.js SDK directly in your Deno applications.

• Better maintenance: The Node.js SDK is actively maintained and receives updates faster
• Feature parity: Access to all the latest Appwrite features
• Simplified ecosystem: One less SDK to maintain
• Native compatibility: Deno’s built-in Node.js compatibility makes this seamless

Instead of using this deprecated SDK, install and use the Appwrite Node.js SDK:

import * as sdk from "npm:node-appwrite";

That’s it! The API is identical, so your existing code will work with minimal changes.

• 📖 Deno Node.js Compatibility Guide
• 📦 Appwrite Node.js SDK

The information below is kept for historical reference but should not be used for new projects.

⚠️ Use the Node.js SDK instead: import * as sdk from "npm:node-appwrite";

Deprecated installation (do not use):

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page and your new API secret Key from project’s API keys section.

let client = new sdk.Client();

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    .setSelfSigned() // Use only on dev mode with a self-signed SSL cert
;

Once your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section.

let users = new sdk.Users(client);

let user = await users.create(ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
console.log(user);

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

let client = new sdk.Client();
let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    .setSelfSigned() // Use only on dev mode with a self-signed SSL cert
;

let user = await users.create(ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
console.log(user);

The Appwrite Deno SDK raises AppwriteException object with message, code and response properties. You can handle any errors by catching AppwriteException and present the message to the user or handle it yourself based on the provided error information. Below is an example.

let users = new sdk.Users(client);

try {
    let user = await users.create(ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
} catch(e) {
    console.log(e.message);
}

You can use the following resources to learn more and get help

• 🚀 Getting Started Tutorial
• 📜 Appwrite Docs
• 💬 Discord Community
• 🚂 Appwrite Deno Playground

Minimal supported version for Deno SDK is 1.19.0.

This library is auto-generated by Appwrite custom SDK Generator. To learn more about how you can help us improve this SDK, please check the contribution guide before sending a pull-request.

Please see the BSD-3-Clause license file for more information.