Features

  • startWrapper log req.headers, req.payload; parse req to headers, payload, vars,
Future<void> start(final req, final res) async => await startWrapper(
      req,
      res,
      biz,
      log: true,
      debug: true, // default set false
      // if set null, it can not use 'debug', 
      // if set 'your-appwrite.io-user-id', only 'your-appwrite.io-user-id' user can use 'debug'
      //    will print vars, can override vars from request body
      debugUserId: 'your-appwrite.io-user-id or null', // default to null
    );
  • databases_wrapper Provide closure functions for Create, Update, Get, Query Document.
 final fnCeateDoc = buildFnCreateRecord(
    client,
    databaseId: '<your-db-id>',
    collectionId: '<your-doc-collection-id>',
  );

// use
  await fnCeateDoc(documentId: ID.unique(), data: {
    "name": 'test1',
    "age": 123,
  });

  • functions_wrapper Provide closure functions for Create Execution

  • local_test

Getting started

dart pub add appwrite_dart_wrapper

Usage

/// just paste to main.dart

import 'package:appwrite_dart_wrapper/appwrite_dart_wrapper.dart';

Future<void> start(final req, final res) async =>
    await startWrapper(req, res, biz,
        log: true, debugUserId: '<`your appwrite admin user id` or `null`>',
        );

Additional information

Function variables

Function variables supplied by Appwrite in addition to your own defined function variables that you can access from your function code. These variables give you information about your execution runtime environment.

Name Description

  • APPWRITE_FUNCTION_ID Your function's unique ID.

  • APPWRITE_FUNCTION_NAME Your function's name.

  • APPWRITE_FUNCTION_DEPLOYMENT Your function's code deployment unique ID.

  • APPWRITE_FUNCTION_TRIGGER Either 'event' when triggered by one of the selected scopes, 'http' when triggered by an HTTP request or the - Appwrite Console, or 'schedule' when triggered by the cron schedule.

  • APPWRITE_FUNCTION_RUNTIME_NAME Your function runtime name. Can be any of Appwrite supported execution runtimes.

  • APPWRITE_FUNCTION_RUNTIME_VERSION Your function runtime version.

  • APPWRITE_FUNCTION_EVENT 无法用于 函数触发, 只能用于 事件触发 Your function event name. This value is available only when your function trigger is 'event.' This variable value can be any of Appwrite system events.

  • APPWRITE_FUNCTION_EVENT_DATA Your function event payload. This value is available only when your function trigger is 'event'. This variable value contains a string in JSON format with your specific event data.

  • APPWRITE_FUNCTION_DATA 无法用于 事件触发, 只能用于HTTP/SDK/Console触发 Your function's custom execution data. This variable's value contains a string in any format. If the custom data is in JSON FORMAT, it must be parsed inside the function code. Note that this variable can be set only when triggering a function using the SDK or HTTP API and the Appwrite Dashboard.

  • APPWRITE_FUNCTION_PROJECT_ID Your function's project ID.

  • APPWRITE_FUNCTION_USER_ID The userId of the user that triggered your function's execution. Executions triggered in the Appwrite console will be prepended with "admin-".

  • APPWRITE_FUNCTION_JWT A JSON Web Token generated for the user that executes your function.

cmd

dart pub publish --server=https://pub-web.flutter-io.cn

Libraries

appwrite_dart_wrapper