Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias Realm

    type Realm = {
        addCustomDomain(
            realmName: string,
            domain: string,
        ): Promise<RealmSkeleton>;
        createRealm(
            realmName: string,
            realmData?: RealmSkeleton,
        ): Promise<RealmSkeleton>;
        deleteRealm(realmId: string): Promise<RealmSkeleton>;
        deleteRealmByName(realmName: string): Promise<RealmSkeleton>;
        exportRealms(): Promise<RealmExportInterface>;
        importRealms(
            importData: RealmExportInterface,
            realmId?: string,
            realmName?: string,
            resultCallback?: ResultCallback<RealmSkeleton>,
        ): Promise<RealmSkeleton[]>;
        readRealm(realmId: string): Promise<RealmSkeleton>;
        readRealmByName(realmName: string): Promise<RealmSkeleton>;
        readRealms(): Promise<RealmSkeleton[]>;
        removeCustomDomain(
            realmName: string,
            domain: string,
        ): Promise<RealmSkeleton>;
        updateRealm(
            realmId: string,
            realmData: RealmSkeleton,
        ): Promise<RealmSkeleton>;
    }
    Index
    • Add custom DNS domain name (realm DNS alias)

      Parameters

      • realmName: string

        realm name

      • domain: string

        domain name

      Returns Promise<RealmSkeleton>

      a promise resolving to a realm object

    • Delete realm by name

      Parameters

      • realmName: string

        realm name

      Returns Promise<RealmSkeleton>

      a promise resolving to a realm object

    • Import realms. Every realm is tried: a realm that cannot be imported does not stop the others.

      Parameters

      • importData: RealmExportInterface

        realm import data

      • OptionalrealmId: string

        Optional realm id. If supplied, only the realm of that id is imported. Takes priority over realmName if both are provided.

      • OptionalrealmName: string

        Optional realm name. If supplied, only the realm of that name is imported.

      • OptionalresultCallback: ResultCallback<RealmSkeleton>

        Optional callback to process individual results. When given, the outcome of every realm is passed to it as it happens (a failed realm as an error that names it, with the cause nested) and a failed realm does not throw: the realms that could be imported are returned. Without it, the failures are collected and thrown as one error after every realm was tried.

      Returns Promise<RealmSkeleton[]>

      the imported realms

    • Remove custom DNS domain name (realm DNS alias)

      Parameters

      • realmName: string

        realm name

      • domain: string

        domain name

      Returns Promise<RealmSkeleton>

      a promise resolving to a realm object