@marcelkloubert/appwrite-sdk
    Preparing search index...

    Interface AppwriteProjectOptions

    Options for constructor of AppwriteProject class.

    interface AppwriteProjectOptions {
        apiKey?: null | string;
        endpoint?: null | string;
        forwardedUserAgent?: null | string;
        jwt?: null | string;
        locale?: null | string;
        projectId?: null | string;
        selfSigned?: null | boolean;
        sessionId?: null | string;
    }
    Index

    Properties

    apiKey? endpoint? forwardedUserAgent? jwt? locale? projectId? selfSigned? sessionId?

    Properties

    apiKey?: null | string

    The API key. If not defined value is read from APPWRITE_API_KEY environment variable.

    endpoint?: null | string

    Custom endpoint.

    "https://cloud.appwrite.io/v1"
    forwardedUserAgent?: null | string

    Custom forwarded user agent.

    jwt?: null | string

    The JSON Web Token to use.

    locale?: null | string

    The custom locale.

    projectId?: null | string

    The project ID. If not defined value is read from APPWRITE_PROJECT_ID environment variable.

    selfSigned?: null | boolean

    true for self-signed certificate.

    sessionId?: null | string

    Explicit session ID.

    Settings

    Member Visibility

    On This Page

    Properties