iya-sts
    Preparing search index...

    Variable retire

    retire: (id: any, options: any) => Promise<any> = retire

    Type Declaration

      • (id: any, options: any): Promise<any>
      • Removes a realm after telling everybody: marks it retiring, runs the retire hooks, waits (bounded by realms.removalDeliveryTimeoutS) for delivery, then calls remove().

        A removal already in progress is refused; an interrupted one is finished. Never rejects.

        Parameters

        • id: any

          the realm id

        • options: any

          optional; via and initiatingEntity describe who asked

        Returns Promise<any>

        remove()'s answer with a retirement member, or a refusal