sdk-for-deno

KO | EN

gitlite — search

#python #javascript #android #golang #python3 #react #github-actions #typescript #game #java #cli #ruby

★ 81 Open GitHub ↗

[READ-ONLY] Official Appwrite Deno SDK 🦕

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Appwrite Deno SDK

> ⚠️ **DEPRECATED**: This SDK is deprecated. Please use the [Appwrite Node.js SDK](https://github.com/appwrite/sdk-for-node/) with Deno instead.

![License](https://img.shields.io/github/license/appwrite/sdk-for-deno.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.8.0-blue.svg?style=flat-square)
[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)

## 🚨 Migration Notice

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.

### Why migrate?

- **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

### How to migrate

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

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

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

### Learn more about Deno + Node.js compatibility

- 📖 [Deno Node.js Compatibility Guide](https://docs.deno.com/runtime/fundamentals/node/)
- 📦 [Appwrite Node.js SDK](https://github.com/appwrite/sdk-for-node/)

---

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

![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)

## Installation

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

**Deprecated installation (do not use):**
```javascript
import * as sdk from "https://deno.land/x/appwrite/mod.ts";
```

## Getting Started

### Init your SDK

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.

```typescript
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
;
```

### Make your first request

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](https://appwrite.io/docs) section.

```typescript
let users = new sdk.Users(client);

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

### Full Example

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

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

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

### Error Handling

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.

```typescript
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);
}
```

### Learn more

You can use the following resources to learn more and get help
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
- 📜 [Appwrite Docs](https://appwrite.io/docs)
- 💬 [Discord Community](https://appwrite.io/discord)
- 🚂 [Appwrite Deno Playground](https://github.com/appwrite/playground-for-deno)

> Minimal supported version for Deno SDK is 1.19.0.

## Contribution

This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.

## License

Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.

sdk-for-deno

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README